From Fedora Project Wiki
m (Added description of simple way of contribution)
m (Added instructions for single file download)
Line 11: Line 11:
== Download a document ==
== Download a document ==


tbd
If the suggested changes are more extensive or consist of very short elements, e.g. typo corrections, it is probably easier to download that one document from our server and change it.
 
The repository base address is https://pagure.io/fedora-server.
 
To download a published version, go to the "''Files''" tab in the left navigation column, then to ''docs'' and further along the directory tree to ''pages''. Check the browser address field. It should contain '''main''' near the base address. Select the appropriate document file.
 
To download a not yet published version, go to the "''Branches''" tab in the left navigation column. In the "'''stg'''" row select the left most icon "code tree for this branch". The file list then displayed contains a ''stg'' at the top. Follow the directory tree under ''docs'' to the ''pages'' directory. Check the browser address field. It should contain '''blob/stg''' near the base address. Select the appropriate document file.
 
You can edit the document using any text editor. For convenience you should use an asciidoc editor. We recommend AsciidocFX (https://asciidocfx.com). It is quite slim yet sophisticated, and available for all operating systems. The editor includes a preview, which of course can only be an approximation due to the lack of site-specific CSS, but contains the essential elements. 
 
After completion of the editing send the file by email directly to the server documentation coordinator (currently pboy@fedoraproject.org).


== Setting up an authoring environment ==
== Setting up an authoring environment ==


tbd
comming soon

Revision as of 13:44, 5 June 2021

We provide several ways to contribute.

  1. You may send us an email, e.g. while reading a document on our Web pages.
  2. You may download a document, make changes and send it back.
  3. You may create a complete authoring environment using Git and Podman / Docker

Sending an e-mail with proposed changes

A very simple and straightforward approach is indicated when something catches your eye while reading an article, or when you are conducting a review of a single document. Just write your suggestions in the form of "current version" - "proposed version" in an email and send it either to the Fedora Server list, server@lists.fedoraproject.org, or directly to the server documentation coordinator (currently pboy@fedoraproject.org). Suggestions will then be included in the text, or perhaps there will be follow-up questions.

Download a document

If the suggested changes are more extensive or consist of very short elements, e.g. typo corrections, it is probably easier to download that one document from our server and change it.

The repository base address is https://pagure.io/fedora-server.

To download a published version, go to the "Files" tab in the left navigation column, then to docs and further along the directory tree to pages. Check the browser address field. It should contain main near the base address. Select the appropriate document file.

To download a not yet published version, go to the "Branches" tab in the left navigation column. In the "stg" row select the left most icon "code tree for this branch". The file list then displayed contains a stg at the top. Follow the directory tree under docs to the pages directory. Check the browser address field. It should contain blob/stg near the base address. Select the appropriate document file.

You can edit the document using any text editor. For convenience you should use an asciidoc editor. We recommend AsciidocFX (https://asciidocfx.com). It is quite slim yet sophisticated, and available for all operating systems. The editor includes a preview, which of course can only be an approximation due to the lack of site-specific CSS, but contains the essential elements.

After completion of the editing send the file by email directly to the server documentation coordinator (currently pboy@fedoraproject.org).

Setting up an authoring environment

comming soon