Skip to content

Conversation

@j0eybrinkman
Copy link
Contributor

@j0eybrinkman j0eybrinkman commented Mar 1, 2024

Author checklist (Completed by original Author)

  • Good fit for the Rocky Linux project? Title and Author Metatags inserted ?
  • If applicable, steps and instructions have been tested to work
  • Initial self-review to fix basic typos and grammar completed

Rocky Documentation checklist (Completed by Rocky team)

  • 1st Pass (Document is good fit for project and author checklist completed)
  • 2nd Pass (Technical Review - check for technical correctness)
  • 3rd Pass (Detailed Editorial Review and Peer Review)
  • Final approval (Final Review)

```bash
sudo dnf install httpd
```
```bash
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have many examples of unnecessary whitespace throughout this PR. This shouldn't be here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have many examples of unnecessary whitespace throughout this PR. This shouldn't be here.

Actually, @neelchauhan, he is trying to implement this: https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/#tabbed-content-within-a-document

Which does require the four spaces he is showing. There's an issue with the tabs though, that I've outlined in another comment.

Copy link
Contributor

@sspencerwire sspencerwire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@j0eybrinkman This is good work! There's a slight problem though. I'd recommend editing this and keeping ALL of the 8.9 and 9.3 instructions together, rather than separating them throughout the document. If you want to do it the way you've got it written now, then the alternative change would be to change the tabs to describe the section, for example:

=== "8.9 PHP module list" 

and

=== "9.3 PHP module list"

But overall I think it is far better to only have the two tabs in the document (8.9 and 9.3) and have ALL of the instructions for each version contained inside

You can leave generic instructions (those that work for either version) out of the tabbed content.

Have you looked to see how this appears in the web interface? (In other words, have you successfully installed a local documentation implementation and seen what happens to this document as it is formatted? If not, then I would definitely suggest bundling all of the instructions for each version under one tab.

@j0eybrinkman
Copy link
Contributor Author

@j0eybrinkman This is good work! There's a slight problem though. I'd recommend editing this and keeping ALL of the 8.9 and 9.3 instructions together, rather than separating them throughout the document. If you want to do it the way you've got it written now, then the alternative change would be to change the tabs to describe the section, for example:

=== "8.9 PHP module list" 

and

=== "9.3 PHP module list"

But overall I think it is far better to only have the two tabs in the document (8.9 and 9.3) and have ALL of the instructions for each version contained inside

You can leave generic instructions (those that work for either version) out of the tabbed content.

Have you looked to see how this appears in the web interface? (In other words, have you successfully installed a local documentation implementation and seen what happens to this document as it is formatted? If not, then I would definitely suggest bundling all of the instructions for each version under one tab.

Yes I used the venv method to render the web page before submitting PR.

@j0eybrinkman
Copy link
Contributor Author

Hi @sspencerwire I updated the tabs to be more descriptive. I do prefer the individual tabs for each section of the document rather than grouping them all together. Each set of commands is available under its respective section in the table of contents that way which I like.

@github-actions
Copy link

github-actions bot commented Mar 2, 2024

Test results for 6d45d17:

Number of broken URLs: 1

URL,RESULT,FILENAME
 https://www.linode.com/docs/guides/beginners-guide-to-lxd-reverse-proxy,failed,guides/containers/lxd_web_servers.md

@sspencerwire
Copy link
Contributor

Hi @sspencerwire I updated the tabs to be more descriptive. I do prefer the individual tabs for each section of the document rather than grouping them all together. Each set of commands is available under its respective section in the table of contents that way which I like.

Ok. Thanks @j0eybrinkman I'll approve the changes and merge them and take a look in the web env. :-)

@sspencerwire sspencerwire merged commit 2078bea into rocky-linux:main Mar 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants