One can distinguish several typical types of contribution to Fedora documentation, for which the available tools are suitable in different ways.
There are 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 pageThis 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 button are convenient for this purpose.
Extend an existing documentation domainThis task involves adding one or more new chapter(s) or section(s) with several chapters. For example, adding another container technique to the documentation of containerization.
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 document.
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.
Introduce a new documentation areaThis task involves a new extensive subject area, such as new software or a new administration tool. For example, inclusion of several sections and chapters and the creation of a new, separate repository.
For this type, setting up a local writing environment is useful and worthwhile.
In any case, a prior discussion with the Docs team is necessary, if only to create the technical prerequisites.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4