Skip to content

Commit 4120bd5

Browse files
authored
#1867 fix markdown violation linting in contribute (#1980)
1 parent 529c418 commit 4120bd5

File tree

9 files changed

+385
-404
lines changed

9 files changed

+385
-404
lines changed

README.md

Lines changed: 48 additions & 69 deletions
Large diffs are not rendered by default.

docs/guides/contribute/beginners.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ tags:
1111

1212
# First-Time Contributor Guide
1313

14-
_Everybody starts somewhere. If this is the first time you have contributed to open source documentation on GitHub, congratulations on taking this step. We can not wait to see what you have to say!_
14+
*Everybody starts somewhere. If this is the first time you have contributed to open source documentation on GitHub, congratulations on taking this step. We can not wait to see what you have to say!*
1515

1616
## Git and GitHub
1717

@@ -23,20 +23,20 @@ You may not start out creating and managing repositories for Rocky Linux, but th
2323

2424
Markdown is an easy language that allows you to include formatting, code, and plain text in the same file. The first time you update a document, follow the existing code. It will not be long before you are ready to explore additional features. When the time comes, here are the basics.
2525

26-
* [Basic Markdown](https://www.markdownguide.org/basic-syntax#code)
27-
* [Extended Markdown](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks)
28-
* Some of the more [advanced formatting](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) options we use in our repository
26+
- [Basic Markdown](https://www.markdownguide.org/basic-syntax#code)
27+
- [Extended Markdown](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks)
28+
- Some of the more [advanced formatting](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) options we use in our repository
2929

3030
## Local repository editor
3131

3232
To create a local repository, first find and install a Markdown editor that works with your computer and operating system. Here are some options, but there are others. Use what you know.
3333

34-
* [ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source
35-
* [Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source
36-
* [MarkText](https://github.com/marktext/marktext) - Free, cross-platform, and open source
37-
* [Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source
38-
* [NvChad](https://nvchad.com/) for the vi/vim user and the nvim client. A lot of plugins are available to enhance the editor for markdown. See [this document](https://docs.rockylinux.org/books/nvchad/) for a nice set of installation instructions.
39-
* [VS Code](https://code.visualstudio.com/) - Partially open source, by Microsoft. VS Code is a lightweight and powerful editor available for Windows, Linux and MacOS. To contribute to this document project, you should get the following extensions: Git Graph, HTML Preview, HTML Snippets, Markdown All in One, Markdown Preview Enhanced, Markdown Preview Mermaid Support, and any more that catch your fancy.
34+
- [ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source
35+
- [Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source
36+
- [MarkText](https://github.com/marktext/marktext) - Free, cross-platform, and open source
37+
- [Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source
38+
- [NvChad](https://nvchad.com/) for the vi/vim user and the nvim client. A lot of plugins are available to enhance the editor for markdown. See [this document](https://docs.rockylinux.org/books/nvchad/) for a nice set of installation instructions.
39+
- [VS Code](https://code.visualstudio.com/) - Partially open source, by Microsoft. VS Code is a lightweight and powerful editor available for Windows, Linux and MacOS. To contribute to this document project, you should get the following extensions: Git Graph, HTML Preview, HTML Snippets, Markdown All in One, Markdown Preview Enhanced, Markdown Preview Mermaid Support, and any more that catch your fancy.
4040

4141
## Create a local repository
4242

@@ -52,7 +52,7 @@ Once you have a Markdown editor installed, follow instructions to connect it to
5252

5353
## Submit an update
5454

55-
_Add a missing word, correct an error, or clarify a confusing bit of text._
55+
*Add a missing word, correct an error, or clarify a confusing bit of text.*
5656

5757
1. Start on the page you want to update.
5858

@@ -90,9 +90,9 @@ _Add a missing word, correct an error, or clarify a confusing bit of text._
9090

9191
Once the RL team gets your request, they will respond in one of three ways.
9292

93-
* Accept and merge your PR
94-
* Comment with feedback and ask for changes
95-
* Deny your PR with an explanation
93+
- Accept and merge your PR
94+
- Comment with feedback and ask for changes
95+
- Deny your PR with an explanation
9696

9797
The last response is unlikely. We really want to include your perspective here! If you have to make changes, you will suddenly understand why you need a local repository. The team can [talk you through](https://chat.rockylinux.org/rocky-linux/channels/documentation) what to do next. In good news, it’s still fixable. Follow the comment section of that request to see what further information is requested.
9898

docs/guides/contribute/createnew.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,59 @@ tags:
99

1010
# How To Create a New Document in GitHub
1111

12-
_When you are ready to submit your original written documentation for approval, follow these easy steps:_
13-
12+
*When you are ready to submit your original written documentation for approval, follow these easy steps:*
1413

1514
## With the GitHub GUI
1615

1716
You can complete almost all tasks from the web GUI on GitHub. Here's an example of adding a file you've created on your local machine to the Rocky Linux documentation GitHub repository.
1817

19-
20-
2118
1. Login to your GitHub account.
22-
2. Navigate to the Rocky Linux Documentation repository at [https://github.com/rocky-linux/documentation](https://github.com/rocky-linux/documentation).
19+
2. Navigate to the Rocky Linux Documentation repository at <https://github.com/rocky-linux/documentation>.
2320
3. You should be on the "Main" branch, so check the drop-down label down in the middle section to be sure you are. Your document might not ultimately end up in the "Main" branch, but admins will move it around to where it logically fits later.
24-
4. On the right-hand side of the page, click the "Fork" button, which will create your copy of the documentation.
25-
5. In the middle of the page on the forked copy, just to the left of the Green "Code" drop-down, is an "Add file" button. Click this and choose the "Upload files" option.
21+
4. On the right-hand side of the page, click the ++"Fork"++ button, which will create your copy of the documentation.
22+
5. In the middle of the page on the forked copy, just to the left of the Green "Code" drop-down, is an ++"Add file"++ button. Click this and choose the "Upload files" option.
2623
6. This will allow you to drag and drop files here or browse to them on your computer. Go ahead and use the method that you prefer.
2724
7. Once the file is uploaded, the next thing you need to do is create a Pull Request. This request lets the upstream administrators know you have a new file (or files) that you want them to merge with the master branch.
28-
8. Click on "Pull Request" in the upper-left corner of the screen.
25+
8. Click on `Pull Request` in the upper-left corner of the screen.
2926
9. Write a brief message in the "Write" section letting the administrators know what you've done. (New document, revision, suggested change, etc.) then submit your change.
3027

31-
3228
## From the Git Command-Line
3329

3430
If you prefer to run Git locally on your machine, you can clone the [Rocky Linux Documentation](https://github.com/rocky-linux/documentation) repository, make changes, and then commit changes afterward. To make things simple, execute steps 1-3 using the **With the GitHub GUI** approach above, then:
3531

32+
1. Git clone the repository:
3633

34+
```text
35+
git clone https://github.com/your_fork_name/documentation.git
36+
```
3737
38-
1. Git clone the repository: git clone https://github.com/your_fork_name/documentation.git
3938
2. Now, on your machine, add files to the directory.
40-
3. Example: mv /home/myname/help.md /home/myname/documentation/
41-
4. Next, run Git add for that file name.
42-
5. Example: git add help.md
43-
6. Now, run git commit for the changes you have made.
44-
7. Example: git commit -m "Added the help.md file"
45-
8. Next, push your changes to your forked repository: git push https://github.com/your_fork_name/documentation main
46-
9. Next, repeat steps 6 and 7 above: Create a Pull Request. This request lets the upstream administrators know that you have a new file (or files) that you would like them to merge with the master branch. Click on "Pull Request" in the upper-left corner of the screen.
47-
48-
Watch for comments within the PR for requested revisions and clarifications.
39+
Example:
40+
41+
```bash
42+
mv /home/myname/help.md /home/myname/documentation/
43+
```
44+
45+
3. Next, run Git add for that file name.
46+
Example:
47+
48+
```text
49+
git add help.md
50+
```
51+
52+
4. Now, run git commit for the changes you have made.
53+
Example:
54+
55+
```text
56+
git commit -m "Added the help.md file"
57+
```
58+
59+
5. Next, push your changes to your forked repository:
60+
61+
```text
62+
git push https://github.com/your_fork_name/documentation main
63+
```
64+
65+
6. Next, repeat steps 6 and 7 above: Create a Pull Request. This request lets the upstream administrators know that you have a new file (or files) that you would like them to merge with the master branch. Click on `Pull Request` in the upper-left corner of the screen.
66+
67+
Watch for comments within the PR for requested revisions and clarifications.

docs/guides/contribute/localdocs/local_docs.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,35 @@ You can build the documentation system locally without either Docker or LXD if y
1414

1515
## Procedure
1616

17-
* Clone the docs.rockylinux.org repository:
17+
- Clone the docs.rockylinux.org repository:
1818

19-
```
20-
git clone https://github.com/rocky-linux/docs.rockylinux.org.git
21-
```
19+
```bash
20+
git clone https://github.com/rocky-linux/docs.rockylinux.org.git
21+
```
2222

23-
* Once finished, change into the docs.rockylinux.org directory:
23+
- Once finished, change into the docs.rockylinux.org directory:
2424

25-
```
26-
cd docs.rockylinux.org
27-
```
25+
```bash
26+
cd docs.rockylinux.org
27+
```
2828

29-
* Now clone the documentation repository using:
29+
- Now clone the documentation repository using:
3030

31-
```
32-
git clone https://github.com/rocky-linux/documentation.git docs
33-
```
31+
```bash
32+
git clone https://github.com/rocky-linux/documentation.git docs
33+
```
3434

35-
* Next, install the requirements.txt file for mkdocs:
35+
- Next, install the requirements.txt file for mkdocs:
3636

37-
```
38-
python3 -m pip install -r requirements.txt
39-
```
37+
```bash
38+
python3 -m pip install -r requirements.txt
39+
```
4040

41-
* Finally run the mkdocs server:
41+
- Finally run the mkdocs server:
4242

43-
```
44-
mkdocs serve
45-
```
43+
```text
44+
mkdocs serve
45+
```
4646

4747
## Conclusion
4848

0 commit comments

Comments
 (0)