Skip to content

Conversation

alemorvan
Copy link
Contributor

@alemorvan alemorvan commented Dec 30, 2023

Add a mardown linter configuration file for the repositiory.

Fix some linter errors
Review code style for prompt in chapter Users and Groups

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)

alemorvan and others added 7 commits December 29, 2023 15:07
- nested list
- list
- trailing whitespaces
- remove $ on online command (no return) as suggested by linter
I also add the markdown extension keys (++ctrl+a++). It could be better for us to use pure markdown (to test in pdf to see how it's rendering)
* Remove the references of <kbd>key</kbd> and replace with the markdown equivalent ++key++
* provide a link to the available key section
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.

Hello @alemorvan We need to write up documentation to be included in the contribute section explaining the new file (.markdownlint.yml) and a general document about the choice to use a markdown linter.

@sspencerwire sspencerwire merged commit ae228f5 into rocky-linux:main Jan 1, 2024
Copy link

github-actions bot commented Jan 1, 2024

Test results for b2ef4d5:

Number of broken URLs: 2

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

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