testing
/
wiki
generated from sig_core/wiki-template
10
0
Fork 3
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Upload files to 'docs/guidelines' #3

Merged
alangm merged 10 commits from alangm-openqa-manual-install into main 2024-05-02 14:50:01 +00:00
Conversation 12 Commits 10 Files Changed 2 +301
alangm commented 2023-05-03 18:37:23 +00:00
Member
Copy Link

Adds document openqa_manual_install.md giving a well tested procedure for manual install of openqa for Rockylinux together with a general introduction to the process to be followed.

This will be useful for those who initially wish to go through the install steps manually rather than use the various install scripts that are available.

This is a first time pr here so not sure if it will work.

Adds document openqa_manual_install.md giving a well tested procedure for manual install of openqa for Rockylinux together with a general introduction to the process to be followed. This will be useful for those who initially wish to go through the install steps manually rather than use the various install scripts that are available. This is a first time pr here so not sure if it will work.
alangm added 1 commit 2023-05-03 18:37:24 +00:00
cad8393751 Upload files to 'docs/guidelines' 
Adds document openqa_manual_install.md giving a well tested procedure for manual install of openqa for Rockylinux together with a general introduction to the process to be followed.

This will be useful for those who initially wish to go through the install steps manually rather than use the various install scripts that are available.

This is a first time pr here so not sure if it will work.
alangm requested review from lumarel 2023-05-03 18:53:51 +00:00
alangm requested review from raktajino 2023-05-03 18:53:51 +00:00
alangm requested review from tcooper 2023-05-03 18:53:52 +00:00
lumarel commented 2023-05-04 20:57:40 +00:00
Member
Copy Link

The Guide is not showing up in guidelines because the .pages navigation is not configured, like this here

Do you want to let it show up? :)

The Guide is not showing up in guidelines because the .pages navigation is not configured, like [this here](https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation) Do you want to let it show up? :)
lumarel reviewed 2023-05-04 21:02:33 +00:00
docs/guidelines/openqa_manual_install.md Outdated
@ -0,0 +133,4 @@
### Helper Scripts
see:
https://github.com/rocky-linux/os-autoinst-distri-rocky/tree/develop/scripts
lumarel commented 2023-05-04 21:02:33 +00:00
Member
Copy Link

Could you make this a Markdown link?

Could you make this a Markdown link?
alangm commented 2023-05-05 11:51:47 +00:00
Author
Member
Copy Link

Done, see below.
Thanks Lukas!

Done, see below. Thanks Lukas!
alangm marked this conversation as resolved
lumarel commented 2023-05-04 21:04:48 +00:00
Member
Copy Link

Beside these 2 a very solid guide maybe some formatting cleanup that is needed 🙂

Beside these 2 a very solid guide maybe some formatting cleanup that is needed 🙂
alangm added 1 commit 2023-05-05 11:44:13 +00:00
alangm commented 2023-05-06 10:40:44 +00:00
Author
Member
Copy Link

@lumarel your comments:

  1. "Do you want to let it show up? :)"
    yes, I'll have a try at it. I'm experimenting a lot here so we'll see how it goes.

  2. Resolved I think?

  3. Did you have specific "formatting cleanup that is needed"?
    I have a few things myself that I'd like to sort out.

@lumarel your comments: 1) "Do you want to let it show up? :)" yes, I'll have a try at it. I'm experimenting a lot here so we'll see how it goes. 2) Resolved I think? 3) Did you have specific "formatting cleanup that is needed"? I have a few things myself that I'd like to sort out.
👍 1
raktajino commented 2023-06-28 19:28:48 +00:00
Member
Copy Link

Hey Alan, it looks like the issue Lukas pointed out is still occurring. I think you need to update docs/guidelines/.pages to make sure your page shows up (see docs/.pages for examples)

Hey Alan, it looks like the issue Lukas pointed out is still occurring. I think you need to update `docs/guidelines/.pages` to make sure your page shows up (see `docs/.pages` for examples)
raktajino commented 2023-06-29 14:07:36 +00:00
Member
Copy Link

The two other changes I suggested in the testing meeting:

You have the user using root to make any changes to the local copy of the testing repository, which is one way to do this. Another way is to add the user to the geekotest group, like so:

sudo usermod -aG geekotest [user]

The other thing was that you advise using sudo vi to edit files, which will work. I've always been recommended to use sudoedit instead. Neither of these are blockers by any means, just enhancement suggestions. Whether you decide to make these two changes or not, this documentation looks good to me.

The two other changes I suggested in the testing meeting: You have the user using root to make any changes to the local copy of the testing repository, which is one way to do this. Another way is to add the user to the `geekotest` group, like so: ``` sudo usermod -aG geekotest [user] ``` The other thing was that you advise using `sudo vi` to edit files, which will work. I've always been recommended to use `sudoedit` instead. Neither of these are blockers by any means, just enhancement suggestions. Whether you decide to make these two changes or not, this documentation looks good to me.
alangm added 1 commit 2023-06-30 09:58:37 +00:00
alangm commented 2023-06-30 10:33:31 +00:00
Author
Member
Copy Link

@raktajino Thank you for your comments. I didn't know about sudoedit so another TIL.

I tried to use geekotest group entry in the past and had some difficulty with it. I take your point though and I will look at it again and put it in when I get it working.

Keep the comments coming please, they are most appreciated. I'm certain to get more TIL's that way. :-)

@raktajino Thank you for your comments. I didn't know about sudoedit so another TIL. I tried to use geekotest group entry in the past and had some difficulty with it. I take your point though and I will look at it again and put it in when I get it working. Keep the comments coming please, they are most appreciated. I'm certain to get more TIL's that way. :-)
alangm added 1 commit 2024-04-22 13:24:41 +00:00
alangm added 1 commit 2024-04-26 09:19:16 +00:00
alangm added 1 commit 2024-04-26 09:20:13 +00:00
alangm commented 2024-04-26 09:30:54 +00:00
Author
Member
Copy Link

I have edited the code in line with @raktajino comments above. I have still to add the navigation details mentioned above @lumarel and will do soon.
Thanks you all for your comments.

I have edited the code in line with @raktajino comments above. I have still to add the navigation details mentioned above @lumarel and will do soon. Thanks you all for your comments.
alangm added 1 commit 2024-04-27 12:58:12 +00:00
alangm added 1 commit 2024-04-27 15:29:09 +00:00
alangm commented 2024-04-27 15:32:07 +00:00
Author
Member
Copy Link

Getting close but section on createhdds is very important and is still to be added.
Will also need some description of openqa-cli api -X POST... to get people started.

Getting close but section on createhdds is very important and is still to be added. Will also need some description of openqa-cli api -X POST... to get people started.
alangm added 1 commit 2024-04-28 12:37:19 +00:00
alangm changed title from WIP: Upload files to 'docs/guidelines' to Upload files to 'docs/guidelines' 2024-04-28 12:38:31 +00:00
tcooper commented 2024-04-30 04:27:34 +00:00
Member
Copy Link

@alangm You've done a lot of work on this (THANK YOU!) and while I don't want my feedback to block some of the formatting changes (eg. proper representation of openQA) are important. I will approve when the blocking changes are made while the non-blocking ones could be tackled (or not) later.

blocking

  • Please change all instances of OpenQA, Openqa, etc... with openQA (lower case letter o) in body text. This does not include openqa within commands (eg. openqa-cli) or paths (eg. /var/lib/openqa/...)
  • replace here link text with phrases that describe where the link is going. eg. the openQA VARIABLES definition document. NOTE: There is more than one of these going to different locations.
  • all script names, commands and paths in body text (outside codeblocks) should be formatted as inline code, (eg. createhdds, openqa-cli, /var/lib/openqa/factory/hdd/fixed)
  • reformat various testing variables and their possible values as inline code, (eg. QEMUCPU)
  • reformat Glossary items as a un-numbered list in Markdown.

non-blocking

  • Optionally, with material for mkdocs extension, use definition list for Glossary.
  • Consider an alternate section heading to replace Problem in the Using Templates section. I prefer challenge over problem but that is too short for a section heading and general search / replace. I understand you are introducing the use of templates.fif.json which is a Fedora construct for configuring openQA from os-autoinst-distri-fedora that we inherited. The docstring in fifloader.py describing this is a lot to take in... I wonder if it wouldn't be useful to digest / extract some of that text and reference the source in this section?
@alangm You've done a lot of work on this (THANK YOU!) and while I don't want my feedback to block some of the formatting changes (eg. proper representation of openQA) are important. I will approve when the **blocking** changes are made while the **non-blocking** ones could be tackled (or not) later. ### blocking - Please change all instances of OpenQA, Openqa, etc... with openQA (lower case letter o) in body text. This does **not** include `openqa` within commands (eg. `openqa-cli`) or paths (eg. `/var/lib/openqa/...`) - replace [here](https://github.com/rocky-linux/os-autoinst-distri-rocky/blob/develop/VARIABLES.md) link text with phrases that describe where the link is going. eg. [the openQA `VARIABLES` definition document](https://github.com/rocky-linux/os-autoinst-distri-rocky/blob/develop/VARIABLES.md). _NOTE: There is more than one of these going to different locations._ - all script names, commands and paths in body text (outside codeblocks) should be formatted as inline code, (eg. `createhdds`, `openqa-cli`, `/var/lib/openqa/factory/hdd/fixed`) - reformat various testing variables and their possible values as inline code, (eg. `QEMUCPU`) - reformat Glossary items as a un-numbered list in Markdown. ### non-blocking - **_Optionally_**, with [material for mkdocs extension](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#definition-lists), use definition list for Glossary. - Consider an alternate section heading to replace **Problem** in the **Using Templates** section. I prefer _challenge_ over _problem_ but that is too short for a section heading and general search / replace. I understand you are introducing the use of `templates.fif.json` which is a Fedora construct for configuring openQA from `os-autoinst-distri-fedora` that we inherited. The docstring in `fifloader.py` describing this is a lot to take in... I wonder if it wouldn't be useful to digest / extract some of that text and reference the source in this section?
alangm commented 2024-04-30 09:35:33 +00:00
Author
Member
Copy Link

Thank you @tcooper your review and comments are appreciated. I'll get the changes in soon.

Thank you @tcooper your review and comments are appreciated. I'll get the changes in soon.
alangm added 1 commit 2024-04-30 13:14:31 +00:00
alangm commented 2024-04-30 13:27:10 +00:00
Author
Member
Copy Link

@tcooper Thank you for your comments, I was thinking along the same lines for a lot of them.

Your blocking comments are agreed and implemented but I will need a wee bit more time to address the non-blocking ones.
I do agree with these and I will make the necessary changes once I've had a chance to get to it.

If any of the current changes are not what you wished to see, or indeed if you spot any errors, please let me know and I'll edit to suit.

@tcooper Thank you for your comments, *I was thinking along the same lines for a lot of them*. Your blocking comments are agreed and implemented but I will need a wee bit more time to address the non-blocking ones. I do agree with these and I will make the necessary changes once I've had a chance to get to it. If any of the current changes are not what you wished to see, or indeed if you spot any errors, please let me know and I'll edit to suit.
tcooper approved these changes 2024-05-01 14:50:22 +00:00
alangm merged commit bea253a9ce into main 2024-05-02 14:50:01 +00:00
alangm commented 2024-05-02 15:18:21 +00:00
Author
Member
Copy Link

Looks like that merge wasn't signed as Trevor said it wouldn't be. Next time I'll merge from the command line and see if that ends up with a signed merge commit from me.

Looks like that merge wasn't signed as Trevor said it wouldn't be. Next time I'll merge from the command line and see if that ends up with a signed merge commit from me.
Sign in to join this conversation.
Reviewers
No reviewers
lumarel
raktajino
tcooper
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: testing/wiki#3
No description provided.
Delete Branch "alangm-openqa-manual-install"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?