Overview - Fedora-Council/council-docs

Fedora-Council / council-docs

Created Sep 1, 2017

Was maintained by mattdm

Official documentation for Fedora Project and Fedora Council

Clone (HTTPS)

git clone

== Fedora Governance Docs === _Components:_ Project & Council // NOTE: Follow the One Sentence Per Line convention for AsciiDoc when making changes to this document. // https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line [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/#/#council:fedoraproject.org] image::https://img.shields.io/badge/Chat-in?style=flat&logo=Matrix&label=%23council%3Afedoraproject.org&link=https%3A%2F%2Fmatrix.to%2F%23%2F%23council%3Afedoraproject.org[Join us at #council:fedoraproject.org on Matrix] Please report issues and submit pull requests for *Content Fixes* to various Fedora governance documentation against this repo. This repository includes two different Antora components: * https://docs.fedoraproject.org/en-US/project/[Fedora Project] * https://docs.fedoraproject.org/en-US/council/[Fedora Council] 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 Fedora governance documentation is stored https://forge.fedoraproject.org/council/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://forge.fedoraproject.org/docs/tickets[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: [source,bash] .... ./docsbuilder.sh .... The preview is hosted at http://localhost:8080[http://localhost:8080]. [[contact]] === How to contact the Council You can find the Fedora Council in the following places: * *Fedora Discussion*: https://discussion.fedoraproject.org/tag/council[#council tag on Fedora Discussion] * *Fedora Chat/Matrix*: https://matrix.to/#/#council:fedoraproject.org[#council:fedoraproject.org]