You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/contribute/beginners.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ tags:
11
11
12
12
# First-Time Contributor Guide
13
13
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!*
15
15
16
16
## Git and GitHub
17
17
@@ -23,20 +23,20 @@ You may not start out creating and managing repositories for Rocky Linux, but th
23
23
24
24
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.
- Some of the more [advanced formatting](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) options we use in our repository
29
29
30
30
## Local repository editor
31
31
32
32
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.
33
33
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.
40
40
41
41
## Create a local repository
42
42
@@ -52,7 +52,7 @@ Once you have a Markdown editor installed, follow instructions to connect it to
52
52
53
53
## Submit an update
54
54
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.*
56
56
57
57
1. Start on the page you want to update.
58
58
@@ -90,9 +90,9 @@ _Add a missing word, correct an error, or clarify a confusing bit of text._
90
90
91
91
Once the RL team gets your request, they will respond in one of three ways.
92
92
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
96
96
97
97
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.
Copy file name to clipboardExpand all lines: docs/guides/contribute/createnew.md
+38-19Lines changed: 38 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,40 +9,59 @@ tags:
9
9
10
10
# How To Create a New Document in GitHub
11
11
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:*
14
13
15
14
## With the GitHub GUI
16
15
17
16
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.
18
17
19
-
20
-
21
18
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>.
23
20
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.
26
23
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.
27
24
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.
29
26
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.
30
27
31
-
32
28
## From the Git Command-Line
33
29
34
30
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:
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.
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.
0 commit comments