ASCIIDOCFX DOWNLOAD DOWNLOAD

README.md, build.sh and preview.sh and a directory docs. Therefore, when the operation terminates, you will find in your current default directory, which is now your working directory, some files, e.g. ~/fedora-server-docs in the above example). Git does „tag“ the cloned repo as remote repo „ upstream“.Īt the same time it checks out the default branch „ main“ into your working directory (i.e. Git will copy the complete server repo including all branches, specifically „main“ and „stg“ mentioned above, into a local repo on your local workstation (into. Still in your default working directory, clone fedora-server repository We use fedora-server-docs in your home throughout this guide This opens up the possibility for others to comment and initiate a broader discussion.Ĭreate a local subdirectory where the files of the documentation should be stored, and make it to your default. Contributions are uploaded to the fork and then transferred to the authoritative version via a pull request. Each contributor should create a fork of the repository for themselves. The workflow folllow the Fedora docs project „ Git for docs writers“. For people with FAS account ssh may be more convenient.

ASCIIDOCFX DOWNLOAD DOWNLOAD

Temporarily, additional branches may also be present.įor up- and download you can use either https or ssh. It has 2 permanent branches: „main“ for the published content and „stg“ for planning, development, and discussion.

The directory structure is predefined by the docs Content Management System (Andorra) and must not be changed. It includes the content as well as various scripts to build and preview the site locally. 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.Īfter completion of the editing send the file by email directly to the server documentation coordinator (currently up an authoring environment It is quite slim yet sophisticated, and available for all operating systems. For convenience you should use an asciidoc editor. You can edit the document using any text editor. In the dialog that opens, save the file to a suitable location on your workstation. 'Right click' onto the RAW button and select 'Save Link As. It should contain blob/stg near the base address. Follow the directory tree under docs to the pages directory. The file list then displayed contains a stg at the top. In the ' stg' row select the left most icon 'code tree for this branch'. To download a not yet published version, go to the ' Branches' tab in the left navigation column.

It should contain main near the base address. 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. typo corrections, it is probably easier to download that one document from our server and change it. If the suggested changes are more extensive or consist of very short elements, e.g. Just write your suggestions in the form of 'current version' - 'proposed version' in an email and send it either to the Fedora Server list, or directly to the server documentation coordinator (currently Suggestions will then be included in the text, or perhaps there will be follow-up questions. 1 Sending an e-mail with proposed changesĪ 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.

Asciidocfx download