user-documentation/README.md

# Fedora Server Edition User Documentation

This repository contains the sources for the Fedora Server Documentation.

## Contributing to this documentation

Steps to do to contribute to the documentation:

Fork this repository, so you are not pushing updates directly into the main branch.

Start adding the actual ASCIIDoc content. While writing, make sure your new source files are included in the nav.adoc configuration file of the module you are using (./modules/ROOT/ ). 
Also make sure to use local preview often to check your markup.

Once you finish, commit your changes and push them to your fork.

Use forge to make a pull request from your fork to the repository’s main branch.

Someone will see your pull request and either merge it, or provide feedback if there is something you should change. Work with the people commenting to make sure your contributions are up to standards.

## The overall documentation structure

```
|-- README.md
|-- antora.yml ....................... 1.
|-- docsbuilder.sh ................... 2.
|-- LICENSE  ......................... 3.
|-- nginx.conf ....................... 4.
|-- site.yml ......................... 5.
`-- modules
    `-- ROOT/ ........................ 6.
        |-- assets
        |   |-- attachments/ ......... 7.
        |   `-- images/ .............. 8.
        |-- nav.adoc ................. 9.
        |-- pages ................... 10.
        |   |-- index.adoc
        |   |-- administration/
        |   |   |-- index.adoc
        |   |   `-- ......adoc
        |   |-- containerization/
        |   |   |-- index.adoc
        |   |   `-- ......adoc
        |   |-- installation/
        |   |   |-- index.adoc
        |   |   `-- ......adoc
        |   |-- services/
        |   |   |-- index.adoc
        |   |   `-- ......adoc
        |   |-- tutorials/
        |   |   |-- index.adoc
        |   |   `-- ......adoc
        |   `-- somedir/
        |       |-- index.adoc
        |       `-- ......adoc
        |
        `-- partials/ .................11.

```
1. Metadata definition.
2. A script that does a local build. It shows a preview of the site in a web browser on localhost:8080 by running a local web server. Uses podman/docker.
3. Licence information for the documentation.
4. Configuration for the local web server mentioned above.
5. A definition file for the build script.
6. A "root module of this documentation component". Please read below for an explanation.
7. Directory containing **attachments** to be used on any page.
8. Directory containing **Iiages** to be used on any page.
9. **Menu definition.** Also defines the hierarchy of all the pages.
10. **Pages with the actual content.** They are organised into subdirectories for specific area of information.
11. Snippets of adoc files reusable in various documentations, organised into subdirectories for specific area of information.

## Components and Modules

Antora introduces two new terms:

* **Component** — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Project, Fedora council, Mindshare, FESCO, but also for subprojects such as CommOps or Modulartity.
* **Module** — A component can be broken down into multiple modules. Modules still share a single menu on the site, but their sources can be stored in different git repositories, even owned by different groups. The default module is called "ROOT" (that's what is in this example). If you don't want to use multiple modules, only use "ROOT". But to define more modules, simply duplicate the "ROOT" directory and name it anything you want. You can store modules in one or more git repositories.

## Local preview

This repo includes a script to build and preview the contents of this repository.

**NOTE**: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.

The script works on Fedora (using Podman) and macOS (using Docker).

To build and preview the site, run:

```
$ ./docsbuilder.sh
```

The result will be available at http://localhost:8080

### Installing Podman on Fedora

Newer Fedora Workstations comes with Podman preinstalled by default — if you do not have it, you need to install it using the following command:

```
$ sudo dnf install podman
```

### Preview as a part of the whole Fedora Docs site

You can also build the whole Fedora Docs site locally to see your changes in the whole context.
This is especially useful for checking if your `xref` links work properly.

To do this, you need to clone the main [Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o), modify the `site.yml` file to reference a repo with your changes, and build it.
Steps:

Clone the main repository and cd into it:

```
$ git clone https://pagure.io/fedora-docs/docs-fp-o.git
$ cd docs-fp-o
```

Find a reference to the repository you're changing in the `site.yml` file, and change it so it points to your change.
So for example, if I made a modification to the Modularity docs, I would find:

```
...
   - url: https://pagure.io/fedora-docs/modularity.git
     branches:
       - master
...
```

And replaced it with a pointer to my fork:
```
...
   - url: https://pagure.io/forks/asamalik/fedora-docs/modularity.git
     branches:
       - master
...
```

I could also point to a local repository, using `HEAD` as a branch to preview the what's changed without the need of making a commit.

**Note:** I would need to move the repository under the `docs-fp-o` directory, because the builder won't see anything above.
So I would need to create a `repositories` directory in `docs-fp-o` and copy my repository into it.

```
...
   - url: ./repositories/modularity
     branches:
       - HEAD
...
```

To build the whole site, I would run the following in the `docs-fp-o` directory.

```
$ ./docsbuilder.sh
```
For more information see [Git for docs writers](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/contributions-quick-repo/)