Skip to content

Conversation

@sspencerwire
Copy link
Contributor

@sspencerwire sspencerwire commented Feb 19, 2022

  • new document on using formatting in the documentation (admonitions,
    tables, numberd lists, block quotes)
  • also covers nesting of these features

Author checklist (Completed by original Author)

  • Contribution a good fit for the Rocky project? Title and Author MetaTags inserted ?
  • Is this a non-English contribution?
  • If applicable, steps and instructions have been tested to work on a real system
  • Did you perform an initial self-review to fix basic typos and grammatical correctness

Rocky Documentation checklist (Completed by Rocky team)

  • 1st Pass (Check that document is good fit for project and author checklist completed)
  • 2nd Pass (Technical Review - check for technical correctness)
  • 3rd Pass (Basic Editorial Review)
  • 4th Pass (Detailed Editorial Review and Peer Review)
  • Final pass/approval (Final Review)

* new document on using formatting in the documentation (admonitions,
tables, numberd lists, block quotes)
* also covers nesting of these features
@sspencerwire
Copy link
Contributor Author

@alemorvan I'd love for you to also review this document. There are things here that you definitely know about and can possibly add clarity to.

@EzequielBruni
Copy link
Collaborator

Oh nice I love this. I'll give it a closer look tomorrow.

@wsoyinka
Copy link
Member

@sspencerwire - many thanks for this. It is really needed and I know, I for one will be referencing it quite a bit :-).
I want to leave my review until it's rendered and available on docs.r.o . Once it's on docs.r.o it'll be much easier to appreciate the [intended] formatting. For this reason, I want to vote for us to just merge and review later .

@sspencerwire
Copy link
Contributor Author

@sspencerwire - many thanks for this. It is really needed and I know, I for one will be referencing it quite a bit :-). I want to leave my review until it's rendered and available on docs.r.o . Once it's on docs.r.o it'll be much easier to appreciate the [intended] formatting. For this reason, I want to vote for us to just merge and review later .

@wsoyinka Sounds good to me. I think I'll let @EzequielBruni at least take a look at it from an editing perspective before we merge. (yes, I can edit my own documents, but I find that I'm not critical enough on me)

sspencerwire and others added 2 commits February 19, 2022 08:58
@sspencerwire sspencerwire merged commit 5115962 into rocky-linux:main Feb 20, 2022
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