= Community Ops Team Docs

// Style rule: one sentence per line please!
// This makes git diffs easier to read. :)

[link=https://creativecommons.org/licenses/by-sa/4.0/]
image::https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg[Fedora Docs content licensed under CC BY-SA 4.0]

[link=https://matrix.to/#/#commops:fedoraproject.org]
image::https://img.shields.io/badge/Chat-in?style=flat&logo=Matrix&label=%23commops%3Afedoraproject.org&link=https%3A%2F%2Fmatrix.to%2F%23%2F%23commops%3Afedoraproject.org[Join us at #commops:fedoraproject.org on Matrix]

Please report issues and submit pull requests for *Content Fixes* to https://docs.fedoraproject.org/en-US/commops/[Fedora Community Ops documentation] against this repo.
General appearance issues and publishing issues should be reported to the https://forge.fedoraproject.org/docs/tickets[Fedora Docs Team].

Never done a pull request (or "PR")?
See the https://guides.github.com/[GitHub Guides] for getting started with git.
If you already know git, see the https://forgejo.org/docs/next/user/pull-requests-and-git-flow/[Forgejo documentation for Pull Requests] on how to submit contributions on _forge.fedoraproject.org_.


[[editing]]
== How to edit these documents

Content for the Community Ops documentation is stored https://forge.fedoraproject.org/commops/docs/src/branch/main/[in this repository].
Source content is written in https://asciidoc.org/[AsciiDoc].
See these resources for help using AsciiDoc:

* https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc Syntax - Quick Reference]
* https://asciidoctor.org/docs/asciidoc-recommended-practices/[AsciiDoc Recommended Practices]
* Advanced topics for Fedora Docs, AsciiDoc, and Antora:
** https://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc Writer's Guide]
** https://docs.antora.org/[Antora Documentation]


[[test]]
== 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 https://pagure.io/fedora-docs/docs-fp-o/[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:

```bash
./docsbuilder.sh
```

The preview is hosted at http://localhost:8080[http://localhost:8080].