Council/council-docs
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
Official Fedora Council Documentation
408 commits 4 branches 0 tags 297 MiB
Find a file
Justin W. Flory (he/him) b5646a0529
docs: Fix Antora start_path for all components 
This commit fixes all Antora configuration files for the components
underneath this repository. When you run the build script, it reports
errors that it is unable to find the reference for the `start_path` for
all of the components. This is because the full path is required,
including the `.adoc` file ending. So, this commit makes the path
explicit and therefore, fixes the errors.

Signed-off-by: Justin W. Flory (he/him) <jwf@redhat.com>
2023-10-14 20:43:48 -05:00
council docs: Fix Antora start_path for all components 2023-10-14 20:43:48 -05:00
engineering docs: Fix Antora start_path for all components 2023-10-14 20:43:48 -05:00
mindshare docs: Fix Antora start_path for all components 2023-10-14 20:43:48 -05:00
project docs: Fix Antora start_path for all components 2023-10-14 20:43:48 -05:00
.gitignore Ignore build artifacts 2023-03-20 09:24:27 -04:00
build.sh 🔧 scripts: Update to latest upstream from template repo 2022-10-28 19:44:35 -04:00
LICENSE.txt 📄 LICENSE: Add Fedora default content license 2022-11-21 09:10:58 -05:00
nginx.conf fix local preview 2019-07-30 11:01:22 +02:00
preview.sh 🔧 scripts: Update to latest upstream from template repo 2022-10-28 19:44:35 -04:00
README.md Fix: Typo in readme and missing preposition 2021-04-04 10:55:22 -04:00
site.yml docs: Fix Antora start_path for all components 2023-10-14 20:43:48 -05:00

README.md

Fedora Council 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 work on Fedora (using Podman) and macOS (using Docker).

To build and preview the site, run:

$ ./build.sh && ./preview.sh

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

Installing Podman on Fedora

Fedora Workstation doesn't come with Podman preinstalled by default — so you might need to install it using the following command:

$ sudo dnf install podman