quality/docs
6
0
Fork 2
Code Issues 3 Pull requests 1 Projects Releases Activity Actions
The adoc files for the Quality section at docs.fp.o https://docs.fedoraproject.org/en-US/qa-docs/
26 commits 1 branch 0 tags 171 KiB
  • Shell 100%
Find a file
Exact
Kamil Páral a38af5ddd5 README: create a proper one 
This replaces the general readme with info particular to our repo. It adds basic
instructions and important references.

Fixes #13
2026-05-20 15:37:07 +02:00
modules/ROOT README: create a proper one 2026-05-20 15:37:07 +02:00
.gitignore update build tooling to make it build again 2024-01-05 10:28:20 +01:00
antora.yml replace IRC with Matrix, add Discussion, change QA to Quality 2024-01-05 12:54:55 +01:00
docsbuilder.sh update docsbuilder.sh 2026-05-14 08:40:08 +02:00
LICENSE post antora 2019-09-21 17:24:38 +05:30
nginx.conf post antora 2019-09-21 17:24:38 +05:30
README.md README: create a proper one 2026-05-20 15:37:07 +02:00
site.yml update build tooling to make it build again 2024-01-05 10:28:20 +01:00

README.md

Fedora Quality Docs

This repository contains source files for the Fedora Quality documentation section at:
https://docs.fedoraproject.org/en-US/qa-docs/

This is accessible from Fedora Docs homepage → Engineering Teams → Fedora QA.

Contributing

On any page at Fedora Quality Docs, you can use the Edit or Bug icon in the top right corner to suggest changes or report issues.

All documentation is written in the AsciiDoc format. Look into modules/ROOT/.

This repo uses the same approach as Fedora Quick Docs, you can read its README for pointers. The basic approach to see documentation rendered is:

$ sudo dnf install podman inotify-tools
$ ./docsbuilder.sh

And visit http://localhost:8080. The docs get automatically regenerated when the sources change. Use Ctrl+C to stop the server.

(Use ./docsbuilder.sh -h to see more options.)

More organization and building help is provided in the Fedora Docs Template readme.

Maintenance

We're integrated in the Fedora Docs building and publishing process, see the Fedora Docs Build repo. It automatically pulls the contents of this repo, rebuilds it regularly, and publishes it.

From time to time, it's good to update the docsbuilder.sh script using:

$ ./docsbuilder.sh -U

Contact

Use this repo to file a ticket, or see QA#Communicate.