Skip to content

Conversation

@hs303
Copy link
Contributor

@hs303 hs303 commented Jun 22, 2024

Hello,
this is my first contribution to the documentation. I hope it meets your requirements.
Thank you for maintaining the project.

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)

@sspencerwire
Copy link
Contributor

sspencerwire commented Jun 22, 2024

@hs303 This is very good! Here's a couple of things to help make it slightly better. (I can always do this on the final edit if you don't want to):

  1. When using the title meta, markdown linters see this as the Level 1 heading for the document, so there is no need to place a level 1 heading inside the content, linters sees this as an error.

  2. You've used "Prerequisite" and "Skills" here and have identical content under them. I'd stick to "Prerequisites" (personal preference). Consider adding something along the lines of "skill managing content from the command line" and "previous experience with SSH key generation helpful, but not required." and bullet those items. Ask yourself the question: What would someone who has never done this before need to know?

  3. A conclusion is a great way to end your document. A simple concluding statement or paragraph is sufficient.

Again, this looks very good and is definitely a good candidate for Rocky Linux documentation. Thank you @hs303 !!

P.S. I won't have time to merge and edit this until later today and possibly not until Monday. --sgs

@github-actions
Copy link

Test results for dd436f7:

Number of broken URLs: 2

URL,RESULT,FILENAME
 https://downloads.linux.hpe.com/repo/spp/GPG-KEY-spp,failed,guides/hardware/hpe_amsd.md
 https://azuremarketplace.microsoft.com/en-us/marketplace/apps/resf.rockylinux-aarch64,failed,guides/cloud/migration-to-new-azure-images.md

@hs303
Copy link
Contributor Author

hs303 commented Jun 22, 2024

@sspencerwire I have tried to address all of your suggestions. Feel free to make some adjustments, if you'd like to. I also decided to add a few words about the key revocation process.

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.

Nice! Thank you again @hs303 !

@sspencerwire sspencerwire merged commit b8ca499 into rocky-linux:main Jun 22, 2024
@sspencerwire
Copy link
Contributor

@all-contributors add @hs303 for content

@allcontributors
Copy link
Contributor

@sspencerwire

I've put up a pull request to add @hs303! 🎉

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.

2 participants