3af0c75a49
This is incomplete and does not fit into user-end documentation in this state. Fixes #101 |
||
|---|---|---|
| modules/ROOT | ||
| .gitignore | ||
| antora.yml | ||
| build.sh | ||
| preview.sh | ||
| README.md | ||
| site.yml | ||
Fedora Quick Docs
This is the content repository for the Fedora Quick Docs
Please report Issues and submit Pull Requests for Content Fixes here. Never done a pull request (or "PR")? Here's the Pagure documentation for Pull Requests.
General appearance issues and publishing issues should be reported against the publishing software.
How to edit these documents
All of this is written in AsciiDoc. It's a simple mostly-plain-text markup language. You may want to look at:
Local preview
This repo includes scripts 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 for instructions.
Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.
To build and preview the site, run:
$ ./build.sh && ./preview.sh
The result will be available at http://localhost:8080
Installing docker on Fedora
$ sudo dnf install docker
$ sudo systemctl start docker && sudo systemctl enable docker