jibecfed / fedora-docs / docs-fp-o

Forked from fedora-docs/docs-fp-o 6 months ago
Clone
README.md

Fedora Docs Build Repository

This is the build repository for the Fedora Documentation Website. Fedora Docs are built using Antora

Want to contribute? Learn about contributing to the Fedora Docs!

Reporting issues

Please report general Issues and submit Pull Requests for Publishing Fixes here. Content issues be reported against the source repositories:

Documentation content

Documentation content is stored in multiple repositories listed in the site.yml file.

Testing your changes locally

Both scripts work on Fedora (using Podman) and macOS (using Docker).

To build the site, run:

$ ./build.sh

Please note the build script uses Docker to build the site in an insolated environment. You might be asked for a root password in order to run it.

The result will be in a ./public/ directory.

To preview the site, either open the ./public/en_US/index.html file in a web browser, or run:

$ ./preview.sh

Branching New Releaess

TBD

Project Plan

See the Project Taiga Board at: https://teams.fedoraproject.org/project/asamalik-antora-for-docs/epics