Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

# Update rockydocs_formatting.md keyboard section #1634

Merged

Conversation

sspencerwire
Copy link
Contributor

@sspencerwire sspencerwire commented Dec 29, 2023

  • Remove the references of key and replace with the markdown equivalent ++key++
  • provide a link to the available key section

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)

* Remove the references of <kbd>key</kbd> and replace with the markdown equivalent ++key++
* provide a link to the available key section
@sspencerwire sspencerwire merged commit a9f6e81 into rocky-linux:main Dec 29, 2023
2 checks passed
Copy link

Test results for 33a1e32:

Number of broken URLs: 2

URL,RESULT,FILENAME
 http://www.jimpryor.net/linux/dcron.html,failed,guides/automation/cronie.md
 https://www.linode.com/docs/guides/beginners-guide-to-lxd-reverse-proxy,failed,guides/containers/lxd_web_servers.md

alemorvan pushed a commit to alemorvan/documentation that referenced this pull request Dec 30, 2023
* Remove the references of <kbd>key</kbd> and replace with the markdown equivalent ++key++
* provide a link to the available key section
sspencerwire added a commit that referenced this pull request Jan 1, 2024
* fix: fix linter problems
- 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)

* feat: add a markdownlint configuration file for the repository

* fix: review linter of advanced commands

* fix: review linter of vi

* fix: review linter and style (prompt style) of users chapter

* # Update `rockydocs_formatting.md` keyboard section (#1634)

* Remove the references of <kbd>key</kbd> and replace with the markdown equivalent ++key++
* provide a link to the available key section

---------

Co-authored-by: sspencerwire <sspencerwire@gmail.com>
@sspencerwire sspencerwire deleted the update_rockydocs_formatting branch January 18, 2024 15:04
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.

1 participant