| |
@@ -15,13 +15,13 @@
|
| |
|
| |
== Organization
|
| |
|
| |
- Fedora uses Antorra CMS to create the documentation WEB site und stores all documents in various git repositories. The Fedora Server documentation is part of the link:https://pagure.io/fedora-server[Fedora Server repository] in the docs subdirectory.
|
| |
+ Fedora uses Antorra CMS to create the documentation WEB site and stores all documents in various git repositories. The Fedora Server documentation is part of the link:https://pagure.io/fedora-server[Fedora Server repository] in the docs subdirectory.
|
| |
|
| |
The pubic user documentation is available at https://docs.fedoraproject.org/en-US/fedora-server/
|
| |
|
| |
== Contributions
|
| |
|
| |
- Authors as well as users should be able to contribute to Fedora Server documentation with as little effort as possible and without technical hurdles. We provide several ways to contribute.
|
| |
+ Authors as well as users should be able to contribute to Fedora Server documentation with as little effort as possible and without technical hurdles. We provide several ways to contribute.
|
| |
|
| |
1. The most common way for casual contributions is to open a ticket and describe the issue, and maybe to make a proposal.
|
| |
2. Edit the page in question using a Web-based page editor.
|
| |
@@ -32,25 +32,25 @@
|
| |
|
| |
=== Open a ticket (problem report)
|
| |
|
| |
- When reading a document, you see a "bug" button on the rightmost side below the blue top bar. Klick and you are forwarded to create an issue. Members of the Working Group are notified and will take care of it. However, you must have a Fedora account, so you can log in.
|
| |
+ When reading a document, you see a "bug" button on the rightmost side below the blue top bar. Click it and you are forwarded to create an issue. Members of the Working Group are notified and will take care of it. However, you must have a Fedora account, so you can log in.
|
| |
|
| |
=== Edit a page via a Web Editor
|
| |
|
| |
- Besides the aforementioned "bug" button there is a button that stylizes pen and note. It leads to a web-based editor that can be used to make changes to this very page. These are not applied directly, but members of the documentation team are notified for a review. Detailed Information comming soon.
|
| |
+ Besides the aforementioned "bug" button there is a button that stylizes pen and note. It leads to a web-based editor that can be used to make changes to this very page. These are not applied directly, but members of the documentation team are notified for a review. Detailed information coming soon.
|
| |
|
| |
=== Working in a local authoring environment
|
| |
|
| |
- For longer-term engagement, it makes sense to set up a complete authoring environment. It requires some preparations, but provides the most powerful set of tools. A separate page will provide detailed information.
|
| |
+ For longer-term engagement, it makes sense to set up a complete authoring environment. It requires some preparations, but it provides the most powerful set of tools. A separate page will provide detailed information.
|
| |
|
| |
=== Sending an email
|
| |
|
| |
- Someone whe can't use one of the above options because they don't have a FAS account, may just write their suggestions or feedback in an email to the Fedora Server list, server@lists.fedoraproject.org, or post a message on our link:https://discussion.fedoraproject.org/tags/c/project/7/server-wg[discussion board]. You have to register, but it is less effort than creating a FAS account. It's best to use a form like "current version" - "proposed version". Suggestions will then be included in the text, or perhaps there will be follow-up questions.
|
| |
+ If you can't use any of the above options because you don't have a FAS account, you can just write your suggestions or feedback in an email to the Fedora Server list, server@lists.fedoraproject.org, or post a message on our link:https://discussion.fedoraproject.org/tags/c/project/7/server-wg[discussion board]. You have to register, but it is less effort than creating a FAS account. It's best to use a form like "current version" - "proposed version". Suggestions will then be included in the text, or perhaps there will be follow-up questions.
|
| |
|
| |
== Quality assurance
|
| |
|
| |
Prior to publication, each article should be reviewed. Such articles are available in our link:https://docs.stg.fedoraproject.org/en-US/fedora-server/[staging area] and marked as "awaiting review" or similar.
|
| |
|
| |
- Reviewer should
|
| |
+ Reviewer should:
|
| |
|
| |
* check for technical and content accuracy. Contact the author in case of questions.
|
| |
* check spelling and syntax
|
| |
@@ -67,9 +67,9 @@
|
| |
|
| |
Some pointers for articles:
|
| |
|
| |
- * Include of author(s), date of creation, last update, Fedora version with which examples were tested.
|
| |
+ * Include of author(s), date of creation, last update, and the Fedora version used to test the examples.
|
| |
* Start with a short summary of the subject matter, objective and desired outcome. (one paragraph of 2-3 sentences)
|
| |
- * Divide longer sequences into sections with subheadings and short explanations
|
| |
+ * Divide longer sequences into sections with subheadings and short explanations.
|
| |
* Provide each step with a brief explanation/justification, if possible, a general instruction structure and a concrete example.
|
| |
|
| |
|
| |
bta
commented 9 months ago
Some typos I saw while reading the pages, and a couple of small rewordings.