- Shell 100%
Justin Wheeler
c445a309b0
This commit removes the `start_path` parameter from the `site.yml` Antora config file, because it is simply not needed anymore! In the previous repository structure, the docs were in a `docs/` directory in the root folder, but now, the Antora tree is in the root directory of this dedicated `commops/docs` repository. I realized this change needed to be made while I was trying to build the docs locally, and the script gave me an error that it could not find the source content. Signed-off-by: Justin Wheeler <jwheel@redhat.com> |
||
|---|---|---|
| modules | ||
| .gitignore | ||
| antora.yml | ||
| docsbuilder.sh | ||
| LICENSE.txt | ||
| nginx.conf | ||
| README.adoc | ||
| site.yml | ||
Please report issues and submit pull requests for Content Fixes to Fedora Community Ops documentation against this repo. General appearance issues and publishing issues should be reported to the Fedora Docs Team.
Never done a pull request (or "PR")? See the GitHub Guides for getting started with git. If you already know git, see the Forgejo documentation for Pull Requests on how to submit contributions on forge.fedoraproject.org.
How to edit these documents
Content for the Community Ops documentation is stored in this repository. Source content is written in AsciiDoc. See these resources for help using AsciiDoc:
-
Advanced topics for Fedora Docs, AsciiDoc, and Antora:
Test with a local preview
This repo includes a shell script to build and preview the contents of this repository.
NOTE: Please note that if you reference pages from other repositories, those links will be broken in the local preview, as it only builds this repository. If you want to rebuild the whole Fedora Docs site, see the Fedora Docs build repository for instructions.
Both of the below scripts use containers, so ensure Podman or Docker is installed on your system before beginning. To build and preview the site, run:
./docsbuilder.shThe preview is hosted at http://localhost:8080.