mwinters/docs-team-docs
1
0
Fork 0
forked from docs/team-docs
Code Pull requests Activity

Update grammatical error and wordiness

Browse source
This commit is contained in:
hank L 2023-04-22 18:11:50 +00:00
commit f995d60f3e
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
modules/ROOT/pages/contributing-docs/index.adoc
View file

@ -1,7 +1,7 @@
= Write contributions to Docs
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
:revnumber: F36 and newer
:revdate: 2023-04-21
:revdate: 2023-04-22
:page-aliases: contributing
@ -67,11 +67,11 @@ The only requirements for contributing documentation to Fedora Docs are:
One can distinguish several typical types of contribution to Fedora documentation, for which the available tools are suitable in different ways.
Many ways for various types of contribution. For example, typo fixes, adding short information or a link, update an article, contribute a new article.
Many ways for various types of contribution. For example, typo fixes, adding short information or a link, update an article, write a new article.
=== Update an existing documentation page
This task involves minor changes. For example, typo fixes, adding short information or a link, or a correction to the text. This type is especially necessary whenever the documentation needs to be updated due to a new software version.
This task involves minor changes. For example, typo fixes, adding short information or a link, or a correction to the text. This type is especially necessary whenever the documentation needs to be updated for a new software version.
The _File Edit tools_ are convenient for this purpose.
@ -79,7 +79,7 @@ The _File Edit tools_ are convenient for this purpose.
This task involves adding one of more new chapter or section(s) with several chapters. For example, adding another container technique to the documentation of containerization.
The _Web interface_ is a convenient tool for this purpose. A local writing environment is useable as well, but may involve too much overhead, if you want contribute to just one documentation.
The _Web IDE_ is a convenient tool for this purpose. A local writing environment is useable as well, but may involve too much overhead if you want contribute to just one documentation.
It is highly recommended to present the plan on one of the Docs communication channels before starting. You may get suggestions and tips on content, but also on editing. For example, file structure and naming conventions.