Skip to content

Commit 35aeebd

Browse files
nishaaaaaantalemorvanSergeCroise
authored
#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]>
1 parent a3cb769 commit 35aeebd

File tree

2 files changed

+33
-21
lines changed

2 files changed

+33
-21
lines changed

contrib_templates/gemstones_template.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,21 @@ tags:
1010
---
1111

1212
# First level header Introduction
13+
1314
Description Here
1415

15-
- https://docs.rockylinux.org/guides/contribute/
16-
- More detailed info: [RockyLinux First-Time Contributor Guide](https://docs.rockylinux.org/guides/contribute/beginners/#first-time-contributor-guide)
16+
- <https://docs.rockylinux.org/guides/contribute/>
17+
- More detailed info: [RockyLinux First-Time Contributor Guide](https://docs.rockylinux.org/guides/contribute/beginners/#first-time-contributor-guide)
1718

18-
!!! warning
19+
!!! warning "Warning"
1920

2021
A warning admonition here
2122

2223
## Second level header
2324

2425
Your text here
25-
```
26+
27+
```text
2628
example code block here
2729
```
2830

@@ -33,15 +35,16 @@ Your text here
3335
!!! note "Note Admonition Example"
3436

3537
Here is a note as opposed to a warning
36-
3738

3839
## Third second level header
3940

4041
inline ticks for code keywords `echo $SOMEVAR` like so.
4142

4243
### deeper header here
44+
4345
Your text here
4446
Example of code block with syntax highlighting for a specific language, bash in this case:
47+
4548
```bash
4649
echo $ENV_VAR
4750
if [${wale} || ${sspencerwire}]
@@ -54,12 +57,14 @@ done
5457
5558
single asteriks: *may*
5659
57-
double asteriks: **may**
60+
double asterisk: **may**
61+
62+
## Conclusions
5863
59-
# Conclusions:
6064
It works great!
6165
6266
---
6367
64-
### References/Footnotes:
65-
[14](https://rockylinux.org) (or use a bulleted list, numbered list, etc)
68+
### References/Footnotes
69+
70+
[14](https://rockylinux.org) (or use a bulleted list, numbered list, etc.)

contrib_templates/general_notes.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,44 @@ tags:
99
- 2nd tag
1010
---
1111

12-
# Some ideas regarding general structure of any technical doc:
12+
# Some ideas regarding general structure of any technical doc
13+
14+
## Preamble/Intro
1315

14-
## Preamble/Intro:
1516
Goal, What to achieve
1617
Why to achieve, desired results/benefits
1718
measurable desired results/benefits
1819
General process to be followed
1920
Concerns, Warnings, Notes, Caveats
2021

21-
## Prerequsites:
22+
## Prerequsites
23+
24+
## Special Terminology
2225

23-
## Special Terminology:
26+
## Process
2427

25-
## Process:
2628
Detailed Process steps
27-
Try a link to a footnote/reference secton here
29+
Try a link to a footnote/reference section here
30+
31+
## Dependencies
2832

29-
## Dependencies:
3033
Verified versions of software, libraries used/required
3134

32-
## Going Further:
35+
## Going Further
36+
3337
Links for additional customizations
3438

35-
## Conclusions:
39+
## Conclusions
40+
3641
It works great!
3742

3843
---
39-
## Glossary:
4044

41-
## REFERENCES:
45+
## Glossary
46+
47+
## REFERENCES
48+
4249
1. Footnotes/Reference links (URLs, manpage websites, etc)
43-
2. Links to scripts, code and custom programs (for posterity in some cases if the originals might disappear )
50+
2. Links to scripts, code and custom programs (for posterity in some cases if the originals might disappear)
4451

4552
## Plus all the things I've thought of in the past and can't remember

0 commit comments

Comments
 (0)