Skip to content

Commit cad1f67

Browse files
authored
Contributor documents changes: (#2762)
* `README.md`replace contractions, define acronyms, replace passive voice with active * `style_guide.md` define acronyms, replace passive voice with active, add new links and admonitions * `beginners.md` add link to `style_guide.md` replace passive voice with active, replace conjunctions with words, some sentence simplification
1 parent 967bba4 commit cad1f67

File tree

3 files changed

+63
-52
lines changed

3 files changed

+63
-52
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Introduction
99

10-
*With Rocky Linux emerging as a major RHEL-compatible distribution, this is an exciting time in the open source community. Rocky Linux’s [mission](https://rockylinux.org/community-charter/) is to provide companies and individuals with a **stable foundation of open source software** for their enterprise and HPC needs. We are here to support that mission with excellent documentation.*
10+
*With Rocky Linux (RL) emerging as a major RHEL-compatible distribution, this is an exciting time in the open source community. Rocky Linux’s [mission](https://rockylinux.org/community-charter/) is to provide companies and individuals with a **stable foundation of open source software** for their enterprise and High Performance Computing (HPC) needs. We are here to support that mission with excellent documentation.*
1111

1212
To us, excellent documentation hits these marks:
1313

@@ -21,7 +21,7 @@ We welcome anyone who wants to be part of this mission. No specific degree, year
2121

2222
## License
2323

24-
Documents written by the *rocky linux documentation team* are published under the Creative Commons-BY-SA license. This means you are free to copy, distribute and transform the works, while respecting the author's rights.
24+
Documents written by the *Rocky Linux documentation team* are published under the Creative Commons-BY-SA license. This means you are free to copy, distribute and transform the works, while respecting the author's rights.
2525

2626
- **BY**: Attribution. You must cite the name of the original author.
2727
- **SA**: Share Alike.
@@ -33,7 +33,7 @@ The documents and their sources are freely downloadable from:
3333
- <https://docs.rockylinux.org>
3434
- <https://github.com/rocky-linux/documentation>
3535

36-
Our media sources are hosted at github.com. You'll find the source code repository where the version of this document was created.
36+
We host our media sources at github.com. Our team created this document on this source code repository, and stores all other documents there too.
3737

3838
## Technical requirements
3939

@@ -49,29 +49,29 @@ Rocky Linux uses GitHub to manage its code and files, including documentation fi
4949

5050
### Markdown
5151

52-
Documentation is welcome in whatever format you are used to creating. It does not need to be perfect, just submit what you have and the team will give you feedback to help get it in line with our voice and tone.
52+
Documentation is welcome in whatever format you create it in. It does not need to be perfect, just submit what you have and the team will give you feedback to help get it inline with our voice and tone.
5353

5454
That said, RL Documentation uses Markdown as the standard. It is easy to learn and use. Run a text converter on your content or start from scratch with this guide on [writing markdown with proper formatting](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting).
5555

56-
As you become a regular contributor, you’ll need to create a **local repository**. See our [guide](https://docs.rockylinux.org/guides/contribute/beginners) for how to install a Markdown editor and create a local repository on your home computer.
56+
As you become a regular contributor, you will need to create a **local repository**. See our [guide](https://docs.rockylinux.org/guides/contribute/beginners) for how to install a Markdown editor and create a local repository on your home computer.
5757

58-
## Contribution Process
58+
## Contribution process
5959

60-
*The actual process of reporting an issue, revising, or creating a doc. Please see special notes afterward about translations, links, and meta content.*
60+
*The actual process of reporting an issue, revising, or creating a doc. See the "Notes" section for translations, links, and meta content.*
6161

6262
### Report an issue
6363

64-
Maybe you’ve found a broken link or incorrect information while exploring the Rocky docs. This is called an **issue**, and we want to know about it. You can mention it on the Mattermost Documentation channel, or visit GitHub and make a proper issue report. GitHub has [a handy guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) for how to create an issue.
64+
Maybe you have found a broken link or incorrect information while exploring the Rocky docs. We call this an **issue**, and we want to know about it. You can mention it on the Mattermost Documentation channel, or visit GitHub and make a proper issue report. GitHub has [a handy guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) for how to create an issue.
6565

6666
### Submit an update
6767

68-
*Add a missing word, correct an error, or clarify a confusing bit of text. You won’t break anything because someone will review your contribution before it goes live. Here is the basic process.*
68+
*Add a missing word, correct an error, or clarify a confusing bit of text. You will not break anything because someone will review your contribution before it goes live. Here is the basic process.*
6969

7070
1. Start on the page you want to update on <https://docs.rockylinux.org/>.
7171

72-
Click the “Edit” pencil in the upper right corner of the document. You will be taken to the original document stored on GitHub.
72+
Click the “Edit” pencil in the upper right corner of the document. This takes you to the original document stored on GitHub.
7373

74-
The first time you contribute to the RL repository, you will be prompted with a green button to “**Fork** this **repository** and propose changes.” This creates a duplicate copy of the RL repository where you make your suggested edits. Click the green button and continue.
74+
The first time you contribute to the RL repository, you will receive a prompt with a green button to “**Fork** this **repository** and propose changes.” This creates a duplicate copy of the RL repository where you make your suggested edits. Click the green button and continue.
7575

7676
2. Make your changes
7777

@@ -85,9 +85,9 @@ Maybe you’ve found a broken link or incorrect information while exploring the
8585

8686
4. Review changes
8787

88-
Now you can look at what you’ve done, line by line. If you missed anything, back up to the previous page and correct it again (you’ll have to start over), then click Propose Changes again.
88+
Now you can review what your changes, line by line. If you missed anything, back up to the previous page and correct it again (you will have to start over), then click Propose Changes again.
8989

90-
Once the doc is the way you want it, click the green button that says Create Pull Request. This provides one more chance to double check your changes and confirm the doc is ready.
90+
Once the doc is the way you want it, click the green button that says Create Pull Request (PR). This provides one more chance to double check your changes and confirm the doc is ready.
9191

9292
5. Create Pull Request
9393

@@ -103,17 +103,17 @@ Maybe you’ve found a broken link or incorrect information while exploring the
103103
- Comment with feedback and ask for changes
104104
- Deny your PR with explanation
105105

106-
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.
106+
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 is still fixable.
107107

108108
Need more in-depth explanation? Here are the [same directions](https://docs.rockylinux.org/guides/contribute/beginners/) with more elaboration under the heading, "Submit an update."
109109

110-
Success? Welcome to the team, you are officially a Rocky Linux documentation contributor. Your profile will be added to the contributor list at the bottom of this document shortly.
110+
Success? Welcome to the team, you are officially a Rocky Linux documentation contributor. We will add your profile to the contributor list at the bottom of this document shortly.
111111

112112
### Become a frequent contributor
113113

114114
For more than a word or two of occasional edits, we recommend that you [setup a local repository](https://docs.rockylinux.org/guides/contribute/createnew/) on your own machine. From there, you can revise documentation from your clone of the RL repository, Commit it to your online GitHub repository, and then create Pull Requests to merge with the main repository.
115115

116-
Advanced users may wish to create a complete documentation server on your local Linux workstation or VM. We have guides to set that up with [Docker](https://docs.rockylinux.org/guides/contribute/localdocs/rockydocs_web_dev/) or [LXD](https://docs.rockylinux.org/guides/contribute/localdocs/mkdocs_lsyncd/). We also have a [fast documentation system](https://docs.rockylinux.org/guides/contribute/localdocs/local_docs/) with special caveats if you are using Python on the same server.
116+
Advanced users might want to create a complete documentation server on your local Linux workstation or VM. We have guides to set that up with [Docker](https://docs.rockylinux.org/guides/contribute/localdocs/rockydocs_web_dev/) or [LXD](https://docs.rockylinux.org/guides/contribute/localdocs/mkdocs_lsyncd/). We also have a [fast documentation system](https://docs.rockylinux.org/guides/contribute/localdocs/local_docs/) with special caveats if you are using Python on the same server.
117117

118118
### Submit a new document
119119

@@ -139,13 +139,13 @@ tags:
139139

140140
#### Formatting
141141

142-
To add more advanced elements to your Markdown-formatted document beyond text, visit the [formatting guide](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/). This covers Admonitions, Tables, Quotes, and more.
142+
To add more advanced elements to your Markdown-formatted document beyond text, visit the [formatting guide](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/). This covers admonitions, tables, quotes, and more.
143143

144144
#### Contribute
145145

146146
The process for [submitting original content](https://docs.rockylinux.org/guides/contribute/createnew/) is similar to updating an existing document from your local repository. Create a new document within your Markdown editor, Commit it to your GitHub repository, then submit a Pull Request to merge into the main branch of the repository. The documentation leads will decide where the new document will live.
147147

148-
## Special Notes
148+
## Notes
149149

150150
### Links
151151

@@ -155,7 +155,7 @@ The format for all links within the documentation is square brackets around the
155155

156156
[our site] followed by your link in parenthesis: (<https://example.com>)
157157

158-
To help lab-based URLs pass our automatic URL checker, we have created a list of excluded names you may use. You may request that a new exclusion be added. An editor may adjust your lab-based URL, or add an exclusion if they think it is warranted.
158+
To help lab-based URLs pass our automatic URL checker, there is a list of excluded names you might use. You can request the adding of a new exclusion if none in the current list work. An editor might adjust your lab-based URL, or add an exclusion if warranted.
159159

160160
Please note the following IEEE recommendation on naming local networks [RFC #8375 Special-Use Domain 'home.arpa.'](https://www.rfc-editor.org/rfc/rfc8375.html) published in May 2018.
161161

@@ -172,11 +172,11 @@ Please note the following IEEE recommendation on naming local networks [RFC #837
172172

173173
### Translation
174174

175-
#### CrowdIn
175+
#### Crowdin
176176

177-
We are adding to these docs in new languages at the speed of getting translators on board. Seeking contributors for this area especially. We use [CrowdIn](https://crowdin.com/) for updates.
177+
We are adding to these docs in new languages at the speed of getting translators on board. Seeking contributors for this area especially. We use [Crowdin](https://crowdin.com/) for updates.
178178

179-
#### Translation and Meta content
179+
#### Translation and meta content
180180

181181
Translators, if you find a word in the source document that does not translate well into your language, or an error that prevents a perfect translation, please fix that in the source document and make a Pull Request. In that case, please add yourself as a contributor in the meta content of that document.
182182

0 commit comments

Comments
 (0)