开源软件名称(OpenSource Name):rocky-linux/documentation开源软件地址(OpenSource Url):https://github.com/rocky-linux/documentation开源编程语言(OpenSource Language):开源软件介绍(OpenSource Introduction):Contribution GuideIntroductionSo you want to contribute to the Rocky Linux documentation, but aren't sure how to go about that? You've come to the right place. We're excited to have you on board with us. One of our main goals for Rocky is to have not just good but GREAT documentation, and we cannot do it alone. This document will get you started and will (hopefully) ease any worries you might have about doing so. We will always be here to help, so feel free to ask questions and join in the conversation. Documentation Subject MatterIf you can dream it — or better yet, have done it before — then your subject matter is probably important to the Rocky Linux documentation project. Now that a Rocky Linux release is available, we expect that documentation submissions will increase. Where do you come in — both now and in the future? If you have experience with anything Linux-related and can translate that to Rocky Linux, we would like you to start writing! Where to StartWhile you can create documentation in any format (seriously, we will accept it any way you create it), the preferred format is Markdown. You can easily create documents in Markdown, plus Markdown is super-easy to learn. The best way to get started with Markdown is to have a Markdown editor installed and read the tutorial. You can create Markdown files with any text editor, but most Markdown editors allow you to preview what you've input already, so they can be very helpful. Markdown EditorAs we've said already, the best way to create Markdown files, particularly if you've not done it before, is to grab an editor for the operating system that you use on your PC or Laptop. A simple web search for "Markdown editors" will show you a bunch to choose from. Pick one to use that is compatible with your Operating System ReText, a cross-platform Markdown editor, was used to create this document. Again, if you prefer to create your Markdown files in your text editor that you are already familiar with, that is just fine. Alternate Markdown EditorsReText is good, but if you feel like exploring your other options, there are a few:
Markdown TutorialYou can get a good feel for how to write Markdown files, by taking a look at Mastering Markdown. This online resource will get you up-to-speed in no time. Admonitions and TranslationsTowards the end of 2021, we started translating our documents using Crowdin. We need more translators for this effort, so if you would like to translate these documents into your language, please consider joining that effort. You can find more information by joining the conversation here. It should be noted that admonitions are NOT required, but if you choose to use them, they should be formatted a little differently than the default. Here is the default way of creating an admonition:
To make this work for our translators in Crowdin, however, we need to format it like this:
The first line of the text detail for the admonition must have that extra line feed. Note that each example shows that there are 4 spaces before the actual text begins. When the page is rendered, the document will not have the extra line feed. Here's what the admonition above looks like: !!! type "optional additional title within double quotes"
If you are reading this on GitHub, it will not display the admonition. You can see how it actually displays here. Using GitLike many other projects out there, Rocky Linux uses "git" to manage its code and files, including documentation files. This tutorial assumes a fundamental knowledge of Git and how it works. The second example also presupposes familiarity with the command line. The steps listed below will get you started. In the meantime (and until we inevitably develop our guide), you can learn Git in-depth with this free Udacity course. If you don't have the time for that, here's a shorter guide. To submit your text, we ask that you create a GitHub account. When you are ready to submit your written documentation for approval, follow these easy steps: With the GitHub GUIYou 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.
From the Git Command-LineIf you prefer to run Git locally on your machine, you can clone the Rocky Linux Documentation repository, make changes, and then commit changes afterward. To make things simple, execute steps 1-3 on from With the GitHub GUI above then:
Once all of the above is complete, you wait for confirmation that GitHub successfully merged your request. (Or not, as the case may be.) More Advanced DocumentsIf you are wanting to add more advanced elements in your document than just text (admonitions, tables, block quotes, etc.), this document will help you get there. Keep Up With The ConversationIf you haven't already, join the conversation on the Rocky Linux Mattermost Server and stay up-to-date with what is going on. Join the ~Documentation channel, or any other channel you are interested in. We'd be glad to have you with us!
Contributors |
wale soyinka |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论