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

Update with conventions and style guide

Browse source
This commit is contained in:
hank L 2023-04-20 22:51:09 +00:00
commit 8a1b917bf2
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-03-23
:revdate: 2023-04-21
:page-aliases: contributing
@ -18,7 +18,7 @@ Other tools are designed to provide a powerful working environment for accomplis
== How it works
Fedora documentation uses the Antora WEB CMS to build and manage the Web site. Documentation is once created static content, with updates from time to time. This is exactly what Antora specializes in. It gathers static text documents and transforms them into a complete Web site, including navigation, links, formatting, positioning, adaptation to different output devices, etc. For more general information about the Antora publishing system, see the https://antora.org/[Antora website] and https://docs.antora.org/antora/latest/page/[Antora documentation].
Fedora documentation uses the Antora to build and manage the Web site. Documentation is once created static content, with updates from time to time. This is exactly what Antora specializes in. It gathers static text documents and transforms them into a complete Web site, including navigation, links, formatting, positioning, adaptation to different output devices, etc. For more general information about the Antora publishing system, see the https://antora.org/[Antora website] and https://docs.antora.org/antora/latest/page/[Antora documentation].
As a writer, you can fully concentrate on the content and your message and write away.
@ -28,9 +28,9 @@ The 4-eyes principle applies to the Fedora documentation. A different author rev
=== Some technical background
Fedora uses _AsciiDoc_ to format text in a simple and efficient way. It closely follows natural writing styles in everyday notes for structuring and highlighting. In this way, you can use any editor, including almost any word processor that can edit and save Ascii Text. More about this below.
Fedora uses _AsciiDoc_ to format text in a simple and efficient way. It closely follows natural writing styles in everyday notes for structuring and highlighting. In this way, you can use any editor, including almost any word processor that can edit and save AsciiDoc Text. More about this below.
The AsciiDoc text document is stored in series of GIT repositories. This is a system especially popular among software developers, but also very capable for managing text documents. GIT encourages and facilitates the use of the 4-eyes principle by a "Pull (or Merge) Request Workflow". You only need to worry about the details of this workflow if you want to set up a local work environment intended for professional and frequent contributions. All other tools take care of the necessary steps in the background.
The AsciiDoc text document is stored in series of Git repositories. This is a system especially popular among software developers, but also very capable for managing text documents. Git encourages and facilitates the use of the 4-eyes principle by a "Pull (or Merge) Request Workflow". You only need to worry about the details of this workflow if you want to set up a local work environment intended for professional and frequent contributions. All other tools take care of the necessary steps in the background.
== Prerequisites