Skip to content

Commit

Permalink
#1867 fix markdown violation linting in contribute (#1980)
Browse files Browse the repository at this point in the history
  • Loading branch information
nishaaaaaant authored Mar 31, 2024
1 parent 529c418 commit 4120bd5
Show file tree
Hide file tree
Showing 9 changed files with 385 additions and 404 deletions.
117 changes: 48 additions & 69 deletions README.md

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/guides/contribute/beginners.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:

# First-Time Contributor Guide

_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!_
*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!*

## Git and GitHub

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

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.

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

## Local repository editor

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.

* [ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source
* [Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source
* [MarkText](https://github.com/marktext/marktext) - Free, cross-platform, and open source
* [Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source
* [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.
* [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.
- [ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source
- [Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source
- [MarkText](https://github.com/marktext/marktext) - Free, cross-platform, and open source
- [Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source
- [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.
- [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.

## Create a local repository

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

## Submit an update

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

1. Start on the page you want to update.

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

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

* Accept and merge your PR
* Comment with feedback and ask for changes
* Deny your PR with an explanation
- Accept and merge your PR
- Comment with feedback and ask for changes
- Deny your PR with an explanation

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.

Expand Down
57 changes: 38 additions & 19 deletions docs/guides/contribute/createnew.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,40 +9,59 @@ tags:

# How To Create a New Document in GitHub

_When you are ready to submit your original written documentation for approval, follow these easy steps:_

*When you are ready to submit your original written documentation for approval, follow these easy steps:*

## With the GitHub GUI

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.



1. Login to your GitHub account.
2. Navigate to the Rocky Linux Documentation repository at [https://github.com/rocky-linux/documentation](https://github.com/rocky-linux/documentation).
2. Navigate to the Rocky Linux Documentation repository at <https://github.com/rocky-linux/documentation>.
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.
4. On the right-hand side of the page, click the "Fork" button, which will create your copy of the documentation.
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.
4. On the right-hand side of the page, click the ++"Fork"++ button, which will create your copy of the documentation.
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.
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.
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.
8. Click on "Pull Request" in the upper-left corner of the screen.
8. Click on `Pull Request` in the upper-left corner of the screen.
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.


## From the Git Command-Line

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:

1. Git clone the repository:

```text
git clone https://github.com/your_fork_name/documentation.git
```

1. Git clone the repository: git clone https://github.com/your_fork_name/documentation.git
2. Now, on your machine, add files to the directory.
3. Example: mv /home/myname/help.md /home/myname/documentation/
4. Next, run Git add for that file name.
5. Example: git add help.md
6. Now, run git commit for the changes you have made.
7. Example: git commit -m "Added the help.md file"
8. Next, push your changes to your forked repository: git push https://github.com/your_fork_name/documentation main
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.

Watch for comments within the PR for requested revisions and clarifications.
Example:

```bash
mv /home/myname/help.md /home/myname/documentation/
```

3. Next, run Git add for that file name.
Example:

```text
git add help.md
```

4. Now, run git commit for the changes you have made.
Example:

```text
git commit -m "Added the help.md file"
```

5. Next, push your changes to your forked repository:

```text
git push https://github.com/your_fork_name/documentation main
```

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.

Watch for comments within the PR for requested revisions and clarifications.
40 changes: 20 additions & 20 deletions docs/guides/contribute/localdocs/local_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,35 @@ You can build the documentation system locally without either Docker or LXD if y

## Procedure

* Clone the docs.rockylinux.org repository:
- Clone the docs.rockylinux.org repository:

```
git clone https://github.com/rocky-linux/docs.rockylinux.org.git
```
```bash
git clone https://github.com/rocky-linux/docs.rockylinux.org.git
```

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

```
cd docs.rockylinux.org
```
```bash
cd docs.rockylinux.org
```

* Now clone the documentation repository using:
- Now clone the documentation repository using:

```
git clone https://github.com/rocky-linux/documentation.git docs
```
```bash
git clone https://github.com/rocky-linux/documentation.git docs
```

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

```
python3 -m pip install -r requirements.txt
```
```bash
python3 -m pip install -r requirements.txt
```

* Finally run the mkdocs server:
- Finally run the mkdocs server:

```
mkdocs serve
```
```text
mkdocs serve
```

## Conclusion

Expand Down
Loading

0 comments on commit 4120bd5

Please sign in to comment.