#1867 fix markdown violation (#1868)

* #1867 fix markdown violation * Update contrib_templates/gemstones_template.md Co-authored-by: Serge Croisé <[email protected]> * Update contrib_templates/gemstones_template.md Co-authored-by: Serge Croisé <[email protected]> * Update contrib_templates/gemstones_template.md Co-authored-by: Serge Croisé <[email protected]> * Update contrib_templates/general_notes.md Co-authored-by: Serge Croisé <[email protected]> * Update contrib_templates/general_notes.md Co-authored-by: Serge Croisé <[email protected]> --------- Co-authored-by: Antoine Le Morvan <[email protected]> Co-authored-by: Serge Croisé <[email protected]>
rocky-linux · Mar 4, 2024 · 35aeebd · 35aeebd
1 parent a3cb769
commit 35aeebd
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 21 deletions.
diff --git a/contrib_templates/gemstones_template.md b/contrib_templates/gemstones_template.md
@@ -10,19 +10,21 @@ tags:
 ---
 
 # First level header Introduction
+
 Description Here
 
- - https://docs.rockylinux.org/guides/contribute/
- - More detailed info: [RockyLinux First-Time Contributor Guide](https://docs.rockylinux.org/guides/contribute/beginners/#first-time-contributor-guide)
+- <https://docs.rockylinux.org/guides/contribute/>
+- More detailed info: [RockyLinux First-Time Contributor Guide](https://docs.rockylinux.org/guides/contribute/beginners/#first-time-contributor-guide)
 
-!!! warning
+!!! warning "Warning"
 
     A warning admonition here
 
 ## Second level header
 
 Your text here
-```
+
+```text
 example code block here
 ```
 
@@ -33,15 +35,16 @@ Your text here
 !!! note "Note Admonition Example"
 
     Here is a note as opposed to a warning
-
 
 ## Third second level header
 
 inline ticks for code keywords `echo $SOMEVAR` like so.
 
 ### deeper header here
+
 Your text here
 Example of code block with syntax highlighting for a specific language, bash in this case:
+
 ```bash
 echo $ENV_VAR
 if [${wale} || ${sspencerwire}]
@@ -54,12 +57,14 @@ done
 
 single asteriks: *may*
 
-double asteriks: **may**
+double asterisk: **may**
+
+## Conclusions
 
-# Conclusions:
     It works great!
 
 ---
 
-### References/Footnotes:
-[14](https://rockylinux.org) (or use a bulleted list, numbered list, etc)
+### References/Footnotes
+
+[14](https://rockylinux.org) (or use a bulleted list, numbered list, etc.)
diff --git a/contrib_templates/general_notes.md b/contrib_templates/general_notes.md
@@ -9,37 +9,44 @@ tags:
   - 2nd tag
 ---
 
-# Some ideas regarding general structure of any technical doc:
+# Some ideas regarding general structure of any technical doc
+
+## Preamble/Intro
 
-## Preamble/Intro:
   Goal, What to achieve
   Why to achieve, desired results/benefits
   measurable desired results/benefits
   General process to be followed
   Concerns, Warnings, Notes, Caveats
 
-## Prerequsites:
+## Prerequsites
+
+## Special Terminology
 
-## Special Terminology:
+## Process
 
-## Process:
   Detailed Process steps
-  Try a link to a footnote/reference secton here
+  Try a link to a footnote/reference section here
+
+## Dependencies
 
-## Dependencies:
   Verified versions of software, libraries used/required
 
-## Going Further:
+## Going Further
+
   Links for additional customizations
 
-## Conclusions:
+## Conclusions
+
   It works great!
 
 ---
-## Glossary:
 
-## REFERENCES:
+## Glossary
+
+## REFERENCES
+
 1. Footnotes/Reference links (URLs, manpage websites, etc)
-2. Links to scripts, code and custom programs (for posterity in some cases if the originals might disappear )
+2. Links to scripts, code and custom programs (for posterity in some cases if the originals might disappear)
 
 ## Plus all the things I've thought of in the past and can't remember