Compare commits
No commits in common. "main" and "main" have entirely different histories.
3
.gitignore
vendored
|
|
@ -3,6 +3,3 @@ gl-code-quality-report.json
|
|||
build
|
||||
cache
|
||||
public
|
||||
|
||||
# created when the docsbuilder local preview is running
|
||||
preview.pid
|
||||
|
|
|
|||
79
README.md
|
|
@ -1,25 +1,70 @@
|
|||
# Fedora Docs Team Documentation
|
||||
# Fedora Docs documentation
|
||||
|
||||
Team and contributor documentation for the Fedora Docs Team.
|
||||
This repository contains a minimal source structure for a new Fedora Docs source.
|
||||
|
||||
## Published documentation
|
||||
## Content of this repo
|
||||
|
||||
The published version of this documentation is available at:
|
||||
[https://docs.fedoraproject.org/en-US/fedora-docs/](https://docs.fedoraproject.org/en-US/fedora-docs/)
|
||||
### Fedora Docs docs (placeholder)
|
||||
|
||||
## Contributing
|
||||
Under `modules/ROOT`, a placeholder for the Fedora Docs docs — intended to be moved to its own repository.
|
||||
|
||||
We welcome contributions! Whether it's fixing a typo, reporting an outdated
|
||||
page, or writing new content — every little bit helps.
|
||||
### Fedora Docs docs / contributing
|
||||
|
||||
See the [Fedora Docs Contributor Guide](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/)
|
||||
for how to get started.
|
||||
Under `modules/contributing`, the contributor's guide — the primary content of this repository.
|
||||
|
||||
Please report **content issues** in this repository.
|
||||
For general site/publishing issues, use the
|
||||
[Fedora Docs Website repository](https://forge.fedoraproject.org/docs/docs-fp-o).
|
||||
## Structure
|
||||
|
||||
## Contact
|
||||
- **Matrix:** [#docs:fedoraproject.org](https://matrix.to/#/#docs:fedoraproject.org)
|
||||
- **Private comms:** Use our FAS emails for anything that shouldn't be public.
|
||||
- **Discussion forums:** [discussion.fedoraproject.org](https://discussion.fedoraproject.org/tag/docs-team/337)
|
||||
```
|
||||
|-- README.md
|
||||
|-- antora.yml ....................... 1.
|
||||
|-- build.sh ......................... 2.
|
||||
|-- preview.sh ....................... 3.
|
||||
|-- site.yml ......................... 4.
|
||||
`-- modules
|
||||
`-- ROOT ......................... 5.
|
||||
|-- assets
|
||||
| `-- images ............... 6.
|
||||
| `-- ...
|
||||
|-- nav.adoc ................. 7.
|
||||
`-- pages .................... 8.
|
||||
|-- ...
|
||||
```
|
||||
|
||||
1. Metadata definition.
|
||||
2. A script that does a local build. Uses docker.
|
||||
3. A script that shows a preview of the site in a web browser by running a local web server. Uses docker.
|
||||
4. A definition file for the build script.
|
||||
5. A "root module of this documentation component". Please read below for an explanation.
|
||||
6. **Images** to be used on any page.
|
||||
7. **Menu definition.** Also defines the hierarchy of all the pages.
|
||||
8. **Pages with the actual content.** They can be also organised into subdirectories if desired.
|
||||
|
||||
## Components and Modules
|
||||
|
||||
Antora introduces two new terms:
|
||||
|
||||
* **Component** — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Project, Fedora council, Mindshare, FESCO, but also subprojects such as CommOps or Modulartity.
|
||||
* **Module** — A component can be broken down into multiple modules. Modules still share a single menu on the site, but their sources can be stored in different git repositories, even owned by different groups. The default module is called "ROOT" (that's what is in this example). If you don't want to use multiple modules, only use "ROOT". But to define more modules, simply duplicate the "ROOT" directory and name it anything you want. You can store modules in one or more git repositories.
|
||||
|
||||
## 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](https://gitlab.com/fedora/docs/-/boards) for instructions.
|
||||
|
||||
Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.
|
||||
|
||||
To build and preview the site, run:
|
||||
|
||||
```
|
||||
$ ./docsbuilder.sh
|
||||
```
|
||||
|
||||
The result will be available at http://localhost:8080
|
||||
|
||||
### Installing docker on Fedora
|
||||
|
||||
```
|
||||
$ sudo dnf install docker
|
||||
$ sudo systemctl start docker && sudo systemctl enable docker
|
||||
```
|
||||
|
|
|
|||
|
|
@ -3,15 +3,14 @@
|
|||
name: fedora-docs
|
||||
|
||||
# Title will be visible on the page.
|
||||
title: Fedora Documentation Team
|
||||
title: Fedora Docs Team
|
||||
|
||||
# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version.
|
||||
version: ~
|
||||
version: master
|
||||
|
||||
# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.
|
||||
start_page: team-info:index.adoc
|
||||
start_page: ROOT:index.adoc
|
||||
|
||||
# This lists all the menu definitions of your component.
|
||||
nav:
|
||||
- modules/team-info/nav.adoc
|
||||
- modules/contributing/nav.adoc
|
||||
- modules/ROOT/nav.adoc
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 261 KiB After Width: | Height: | Size: 261 KiB |
|
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
|
Before Width: | Height: | Size: 161 KiB After Width: | Height: | Size: 161 KiB |
|
Before Width: | Height: | Size: 326 KiB After Width: | Height: | Size: 326 KiB |
|
Before Width: | Height: | Size: 313 KiB After Width: | Height: | Size: 313 KiB |
|
Before Width: | Height: | Size: 230 KiB After Width: | Height: | Size: 230 KiB |
|
Before Width: | Height: | Size: 237 KiB After Width: | Height: | Size: 237 KiB |
|
Before Width: | Height: | Size: 254 KiB After Width: | Height: | Size: 254 KiB |
|
Before Width: | Height: | Size: 318 KiB After Width: | Height: | Size: 318 KiB |
|
Before Width: | Height: | Size: 298 KiB After Width: | Height: | Size: 298 KiB |
|
Before Width: | Height: | Size: 221 KiB After Width: | Height: | Size: 221 KiB |
|
Before Width: | Height: | Size: 222 KiB After Width: | Height: | Size: 222 KiB |
|
Before Width: | Height: | Size: 224 KiB After Width: | Height: | Size: 224 KiB |
|
Before Width: | Height: | Size: 249 KiB After Width: | Height: | Size: 249 KiB |
|
Before Width: | Height: | Size: 197 KiB After Width: | Height: | Size: 197 KiB |
BIN
modules/ROOT/assets/images/contrib-quickdocs/assign-issues.png
Normal file
|
After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 297 KiB After Width: | Height: | Size: 297 KiB |
|
Before Width: | Height: | Size: 173 KiB After Width: | Height: | Size: 173 KiB |
BIN
modules/ROOT/assets/images/contrib-quickdocs/report-issue.png
Normal file
|
After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 91 KiB After Width: | Height: | Size: 91 KiB |
|
Before Width: | Height: | Size: 320 KiB After Width: | Height: | Size: 320 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
BIN
modules/ROOT/assets/images/pagure-guide/assign-issues.png
Normal file
|
After Width: | Height: | Size: 92 KiB |
BIN
modules/ROOT/assets/images/pagure-guide/watch-notification.png
Normal file
|
After Width: | Height: | Size: 91 KiB |
|
Before Width: | Height: | Size: 180 KiB After Width: | Height: | Size: 180 KiB |
|
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 138 KiB |
|
Before Width: | Height: | Size: 153 KiB After Width: | Height: | Size: 153 KiB |
|
Before Width: | Height: | Size: 136 KiB After Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 186 KiB After Width: | Height: | Size: 186 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
35
modules/ROOT/nav.adoc
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
//* xref:organizational/index.adoc[How we work]
|
||||
* How we work
|
||||
** xref:organizational/charter.adoc[The Docs Charter]
|
||||
** xref:organizational/meetings.adoc[Docs Meetings]
|
||||
** xref:organizational/workflow.adoc[Docs Workflow organization]
|
||||
|
||||
* xref:contributing-docs/index.adoc[Contribute to improve and expand Docs articles]
|
||||
|
||||
** Contributing to existing documentation
|
||||
// xref:contributing-docs/contrib-existing-documentation.adoc[Contributing to existing documentation]
|
||||
** xref:contributing-docs/contrib-new-documentation.adoc[Create a new documentation module]
|
||||
** xref:contributing-docs/contrib-quickdocs.adoc[Contributing to Quick Docs]
|
||||
** xref:contributing-docs/contrib-release-notes.adoc[Contributing to Release Notes]
|
||||
|
||||
** Contribution Tools
|
||||
*** xref:contributing-docs/tools-gitlab-howto.adoc[HowTo for casual contributions (for GitLab-based pages)]
|
||||
*** xref:contributing-docs/tools-web-ide-ui.adoc[How to profoundly use GitLab UI for document maintenance]
|
||||
//*** xref:contributing-docs/contributions-quick-repo.adoc[How to contribute to Quick Docs repo]
|
||||
*** xref:contributing-docs/tools-file-edit-pagure.adoc[How to edit files on the Pagure Web UI]
|
||||
*** xref:contributing-docs/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment]
|
||||
*** xref:contributing-docs/tools-localenv-preview.adoc[How to run a local preview]
|
||||
*** xref:contributing-docs/tools-vale-linter.adoc[How to check documentation style with Vale]
|
||||
|
||||
** xref:contributing-docs/style-guide.adoc[The docs style guide]
|
||||
** xref:contributing-docs/asciidoc-intro.adoc[AsciiDoc for Fedora]
|
||||
*** xref:contributing-docs/asciidoc-markup.adoc[Markup]
|
||||
*** xref:contributing-docs/asciidoc-reusable-attributes.adoc[Reusable attributes]
|
||||
** xref:contributing-docs/translations.adoc[Working with Translations]
|
||||
|
||||
//* Contribute to keeping Docs up and running
|
||||
* xref:contributing-infra/index.adoc[Contribute to keeping docs up and running]
|
||||
** xref:contributing-infra/design-ux-contribution.adoc[Design the user interface for Docs]
|
||||
|
||||
//* xref:archive/index.adoc[What we have achieved so far]
|
||||
//* What we have achieved so far
|
||||
17
modules/ROOT/pages/archive/contribution-options.adoc
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= How to contribute
|
||||
|
||||
[abstract]
|
||||
____
|
||||
TBD
|
||||
____
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Documentation of work we have done over years
|
||||
|
||||
** Pre Antora docs (Fedora 1 - 2?)
|
||||
====
|
||||
16
modules/ROOT/pages/archive/index.adoc
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Archive
|
||||
|
||||
[abstract]
|
||||
____
|
||||
TBD
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Documentation of work we have done over years
|
||||
|
||||
** Pre Antora docs (Fedora 1 - 2?)
|
||||
====
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= AsciiDoc for Fedora Documentation Writers
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
v0.0.1, 2022-09-26
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= AsciiDoc markup
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
v1.0, 2022-12-10
|
||||
|
|
@ -1,9 +1,7 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Reusable attributes
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
v0.0.1, 2024-06-25
|
||||
// :toc:
|
||||
|
||||
This page explains how to use reusable metadata, or attributes, across multiple AsciiDoc documents in Fedora Documentation.
|
||||
|
||||
|
|
@ -15,7 +13,7 @@ Sometimes you may want to use the same data across many AsciiDoc documents.
|
|||
Some examples are below:
|
||||
|
||||
* Version releases (e.g. Fedora `N`)
|
||||
* URL prefixes or suffixes (e.g. `https://forge.fedoraproject.org/fesco`)
|
||||
* URL prefixes or suffixes (e.g. `https://pagure.io/fesco/issues/`)
|
||||
* Dates and time (e.g. current year, like `2020`)
|
||||
|
||||
For these and more use cases, *attributes* allow you to define some metadata in a single place, and reuse it in multiple places.
|
||||
|
|
@ -94,7 +92,7 @@ Placing this macro on the top line will do the rest:
|
|||
|
||||
[source,adoc]
|
||||
----
|
||||
\include::partial$attributes.adoc[]
|
||||
\include::ROOT:partial$attributes.adoc[]
|
||||
----
|
||||
|
||||
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Contributing to existing documentation
|
||||
|
||||
This section describes how to contribute to existing documentation - that is, documentation that already has been published on the website.
|
||||
Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:index.adoc[Prerequisites].
|
||||
|
||||
[TIP]
|
||||
If you are interested in contributing to Release Notes, see the xref:content/contrib-release-notes.adoc[appropriate page].
|
||||
If you are interested in contributing to Release Notes, see the xref:contributing-docs/contrib-release-notes.adoc[appropriate page].
|
||||
|
||||
Each Fedora Docs page includes an "Edit this Page" link at the top.
|
||||
For simple updates, changes can be submitted directly from the Pagure web interface.
|
||||
|
|
@ -77,7 +74,7 @@ see link:++https://commit.style++[commit.style] by Tim Pope (author of [applicat
|
|||
. If you added any new files, then ensure they are included in a reasonable spot in the repository's [filename]`nav.adoc` configuration file
|
||||
|
||||
. Build locally and make sure everything looks the way you expect.
|
||||
See xref:content/tools-localenv-preview.adoc[Building a local preview] for instructions.
|
||||
See xref:contributing-docs/tools-localenv-preview.adoc[Building a local preview] for instructions.
|
||||
|
||||
. Once you finish, commit your changes and push them to your fork.
|
||||
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Create a new documentation module
|
||||
Francois Andrieu, Fedora Documentation Team
|
||||
|
|
@ -10,7 +9,7 @@ ____
|
|||
This section describes how to add a completely new piece of documentation that covers a new area in its entirety. This spans several pages and is usually associated with the creation of a new, dedicated repository. A local working environment is best suited for this. But it is also possible to use the web IDE of various GIT forges.
|
||||
____
|
||||
|
||||
Before you start following this procedure, review all the requirements listed in xref:index.adoc#_prerequisites[Prerequisites].
|
||||
Before you start following this procedure, review all the requirements listed in xref:contributing-docs/index.adoc#_prerequisites[Prerequisites].
|
||||
|
||||
|
||||
== Documentation repository configuration
|
||||
|
|
@ -18,9 +17,12 @@ Before you start following this procedure, review all the requirements listed in
|
|||
NOTE: While you can create a new repository, or use an existing one, we recommend starting from the provided template repository if you are not familiar with Antora.
|
||||
|
||||
Create your new repository for the new documentation set, or ask someone to create one for you.
|
||||
You can host this repository anywhere but we recommend using https://forge.fedoraproject.org[Fedora Forge] where you can use Fedora groups to control write access to the repository.
|
||||
You can host this repository anywhere but we recommend using https://gitlab.com/fedora[GitLab] where you can use Fedora groups to control write access to the repository.
|
||||
Depending on the topic, it might be preferable to host it under the https://gitlab.com/fedora/docs[Fedora Docs namespace].
|
||||
|
||||
Simply clone the https://forge.fedoraproject.org/docs/docs-template[template repository] manually and copy the content to your new repository.
|
||||
On GitLab, you can use `New project` > `Create from template` > `Group` and pick `Documentation Template` in the list.
|
||||
|
||||
If you are not using GitLab, clone the https://gitlab.com/fedora/docs/templates/fedora-docs-template[template repository] manually and copy the content to your new repository.
|
||||
|
||||
.Example of a simple documentation repository structure
|
||||
----
|
||||
|
|
@ -50,18 +52,18 @@ At this point, the initial configuration is complete. You can push these changes
|
|||
|
||||
Some useful documentation links:
|
||||
|
||||
- xref:content/asciidoc-markup.adoc[]
|
||||
- xref:content/style-guide.adoc[]
|
||||
- xref:contributing-docs/asciidoc-markup.adoc[]
|
||||
- xref:contributing-docs/style-guide.adoc[]
|
||||
|
||||
If your documentation is made of several pages, you can list them in the `nav.adoc`. This file will then be used to build the navigation menu on the left side of docs.fp-o.
|
||||
|
||||
While you're writing, you can use the xref:content/tools-localenv-preview.adoc[local preview] to check the resulting document.
|
||||
While you're writing, you can use the xref:contributing-docs/tools-localenv-preview.adoc[local preview] to check the resulting document.
|
||||
|
||||
== Publish a new documentation module
|
||||
|
||||
Once the repository is set up, and initial content added, it is ready to be published.
|
||||
|
||||
Documentation modules published on docs.fp-o are all listed in the https://forge.fedoraproject.org/docs/docs-fp-o/src/branch/prod/site.yml[main Antora playbook].
|
||||
Documentation modules published on docs.fp-o are all listed in the https://gitlab.com/fedora/docs/docs-website/docs-fp-o/-/blob/prod/site.yml[main Antora playbook].
|
||||
|
||||
To add a new documentation module, you will need to add its repository to the `content.sources` list:
|
||||
|
||||
|
|
@ -69,7 +71,7 @@ To add a new documentation module, you will need to add its repository to the `c
|
|||
----
|
||||
content:
|
||||
sources:
|
||||
- url: https://forge.fedoraproject.org/path/to/new/repository.git
|
||||
- url: https://gitlab.com/path/to/new/repository.git
|
||||
branches: main <.>
|
||||
start_path: docs <.>
|
||||
----
|
||||
|
|
@ -77,7 +79,7 @@ content:
|
|||
<.> This setting is optional. If the documentation files are stored in a subdirectory on your repository (`/docs/` for instance), you must set its relative path here, without leading or trailing slashes. If it is located at the root level, as documented on this page, you can omit this parameter.
|
||||
|
||||
|
||||
You can either create a Pull Request with these changes, or if you do not feel comfortable editing this file, create a ticket on the https://forge.fedoraproject.org/docs/docs-fp-o/issues[Fedora Docs Website repository], and the Documentation Team will handle that part for you.
|
||||
You can either create a Merge Request with these changes, or if you do not feel comfortable editing this file, create a ticket on the https://gitlab.com/fedora/docs/docs-website/docs-fp-o/-/issues[Fedora Docs Website repository], and the Documentation Team will handle that part for you.
|
||||
|
||||
|
||||
[NOTE]
|
||||
|
|
@ -1,10 +1,7 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Contributing to Quick Docs
|
||||
Hanku Lee; Peter Boy; Fedora Documentation Team
|
||||
:revdate: 2023-03-19
|
||||
:page-aliases: content/contributions-quick-repo.adoc
|
||||
:page-aliases: contributing-docs/contributions-quick-repo.adoc
|
||||
|
||||
[abstract]
|
||||
Quick Docs is a collection of shorter how-to guide and more extensive tutorials for users of the Fedora Linux. We provide some tips and hints on contributing to Quick Docs.
|
||||
|
|
@ -65,16 +62,23 @@ image::contrib-quickdocs/report-issue.png[]
|
|||
|
||||
The subject field already contains a link to the affected document. Don't change it. Please, provide a description of the issue and if possible provide a concise suggested modification, preferably cut&paste ready.
|
||||
|
||||
If you are not logged to forge, a FAS login window will open first.
|
||||
|
||||
IMPORTANT: Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge].
|
||||
If you are not logged to pagure, a FAS login window will open first.
|
||||
|
||||
The second link opens a web editor, you can use to enter proposed modifications directly in the text.
|
||||
|
||||
.The web editor
|
||||
image::contrib-quickdocs/report-issue.png[]
|
||||
|
||||
The next steps are explained in detail in the article xref:content/tools-file-edit-pagure.adoc[How to edit files on the Pagure Web UI].
|
||||
The next steps are explained in detail in the article xref:contributing-docs/tools-file-edit-pagure.adoc[How to edit files on the Pagure Web UI].
|
||||
|
||||
=== Self-assign issues
|
||||
|
||||
You can find and contribute to needed changes by following the https://pagure.io/fedora-docs/quick-docs/issues[Quick Docs Issue Board], where users share blunders in the documentation or suggestions for enhancing it.
|
||||
|
||||
If you find issue that matches your interest and expertise, on assignee on top right, press *take* link to assign issue to yourself.
|
||||
|
||||
.Assign issues
|
||||
image::contrib-quickdocs/assign-issues.png[]
|
||||
|
||||
== How to contribute
|
||||
|
||||
|
|
@ -102,7 +106,7 @@ Watch status in the middle of Quick Doc report has four options. Select one of t
|
|||
|
||||
- Unwatch
|
||||
|
||||
Notification will go to your email as in user settings of Forge.
|
||||
Notification will go to your email as in user settings of Pagure.
|
||||
|
||||
.Notification options
|
||||
image::contrib-quickdocs/watch-notification.png[]
|
||||
|
|
@ -120,7 +124,7 @@ If you do not hear from reviewers after your PR longer than a week, leave a comm
|
|||
|
||||
=== Adherence to style guide
|
||||
|
||||
Instead of nitpicking consistency of tone and grammatical errors, reviewers encourage writers to read xref:content/style-guide.adoc#prerequisites[The docs style guide]. If you want automated test, run vale linter locally xref:content/tools-vale-linter.adoc#prerequisites[Check Your Documentation Using Vale].
|
||||
Instead of nitpicking consistency of tone and grammatical errors, reviewers encourage writers to read xref:contributing-docs/style-guide.adoc#prerequisites[The docs style guide]. If you want automated test, run vale linter locally xref:contributing-docs/tools-vale-linter.adoc#prerequisites[Check Your Documentation Using Vale].
|
||||
|
||||
=== Rule sets
|
||||
|
||||
|
|
@ -135,7 +139,7 @@ Beyond style guide, here are a few rule sets contributors need to observe.
|
|||
- Do not use screenshot of terminal. Provide source code block of a particular language or shell commands.
|
||||
|
||||
- Run prose linter like vale locally before PR. Check this link:
|
||||
xref:content/tools-vale-linter.adoc#prerequisites[How to check documentation style with Vale]
|
||||
xref:contributing-docs/tools-vale-linter.adoc#prerequisites[How to check documentation style with Vale]
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Contributing to Release Notes
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
|
||||
|
|
@ -12,7 +11,7 @@ Before you start following this procedure, make sure that you fulfill all the re
|
|||
The Release Notes contribution process is on a separate page because it is different from any other Fedora documentation.
|
||||
If you are interested in contributing to any other docs, see the appropriate page.
|
||||
|
||||
//xref:content/contributing-to-existing-docs.adoc[appropriate page].
|
||||
//xref:contributing-docs/contributing-to-existing-docs.adoc[appropriate page].
|
||||
|
||||
The Release Notes are unique in that, unlike all other documentation, they are written nearly completely from scratch for each new release, while all other docs are being kept between releases, only with updates.
|
||||
This means that some parts of the procedure below, such as the git branch used or the schedule, change with each new release.
|
||||
|
|
@ -51,6 +50,6 @@ If you can’t see the section where you added your contributions at all, make s
|
|||
|
||||
Repeat the above for as many issues as you want.
|
||||
|
||||
//See also the xref:content/tools-localenv-git-guide.adoc[Git for docs writers] page for more detailed information about working with Fedora Documentation git repositories.
|
||||
//See also the xref:contributing-docs/tools-localenv-git-guide.adoc[Git for docs writers] page for more detailed information about working with Fedora Documentation git repositories.
|
||||
|
||||
// If you have any questions, xref:ROOT:index.adoc#find-docs[contact Docs on IRC, Matrix, or the forums].
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
= How to contribute to Quick Docs repo
|
||||
Hanku Lee, Peter Boy; Fedora Documentation Team
|
||||
:revdate: 2023-03-19
|
||||
|
||||
[abstract]
|
||||
Fedora Pagure is an Open Source software code hosting system that supports various Fedora project repositories such as, but not limited to, Quick Docs, Server, EPEL (Extra Packages for Enterprise Linux), Modularity and Packaging Committee. This article steps through contribution process for Quick Docs, which contain how-to guides and tutorials for the Fedora Linux. The overall process can be translated for any other Pagure projects. Pre-requisites to begin your first contribution are Fedora account ID, signed contributor agreement, and some familiarity with git pull request. Docs team is looking for more folks from the community helping with docs.
|
||||
|
||||
== How to find tasks
|
||||
|
||||
Whether it is broken link, outdated screenshots of graphical user interface, technical and grammatical error in Quick Docs, every little contribution helps Fedora Linux users.
|
||||
|
||||
The best place to find how to contribute to Quick Docs is issue board where users report documentation bugs or suggestions to improve documentation.
|
||||
|
||||
Track issues on the link: https://pagure.io/fedora-docs/quick-docs/issues
|
||||
|
||||
=== Self-assign issues
|
||||
|
||||
If you find issue that matches your interest and expertise, on assignee on top right, press *take* link to assign issue to yourself.
|
||||
|
||||
.Assign issues
|
||||
image::pagure-guide/assign-issues.png[]
|
||||
|
||||
== Rule sets
|
||||
|
||||
Beyond style guide, here are a few rule sets contributors need to observe.
|
||||
|
||||
- The process Docs team treat bugs in documentation follows the same principle as code bugs where continuous integration, automated testing, and gradual improvements for documentation quality are adopted.
|
||||
|
||||
- All changes to Quick Docs must be done via Pull Requests from forked project. Quick Docs project does not support direct push to its upstream repo.
|
||||
|
||||
- If you fix contents about new features, releases or new content, test the application and process in a new system or freshly installed Virtual Machine with all updates applied.
|
||||
|
||||
- Do not use screenshot of terminal. Provide source code block of a particular language or shell commands.
|
||||
|
||||
- Run prose linter like vale locally before PR. Check this link:
|
||||
xref:contributing-docs/tools-vale-linter.adoc#prerequisites[How to check documentation style with Vale]
|
||||
|
||||
== Pull Requests and review
|
||||
|
||||
Pull Requests promote collaborative work flow between writers and reviewers where PR comments, edits and commits serve as review process.
|
||||
|
||||
=== Write changes and push to Quick Docs repo
|
||||
|
||||
Please find general Pull Requests (PR) work flow. See the link:
|
||||
xref:contributing-docs/tools-local-authoring-env.adoc#prerequisites[How to create and use a local authoring environment]
|
||||
|
||||
=== Create a pull request from Pagure User Interface
|
||||
|
||||
- Go to your forked project and click *View Fork* on top right of Quick Docs project landing page: https://pagure.io/fedora-docs/quick-docs
|
||||
|
||||
- On your fork, click Open PR and New Pull Request
|
||||
|
||||
- Locate your feature branch (pull from) next to your fork, under main branch
|
||||
|
||||
- Fill in Pull Request Title and describe your changes
|
||||
|
||||
- Check files changed and commits before Pull Request
|
||||
|
||||
- Press the Create Pull Request button below on the right
|
||||
|
||||
=== Notification after PR
|
||||
|
||||
Watch status in the middle of Quick Doc report has four options. Select one of the options from below.
|
||||
|
||||
- Watch Issues and PRs
|
||||
|
||||
- Watch Commits
|
||||
|
||||
- Watch Issues, PRs, and Commits
|
||||
|
||||
- Unwatch
|
||||
|
||||
Notification will go to your email as in user settings of Pagure.
|
||||
|
||||
.Notification options
|
||||
image::pagure-guide/watch-notification.png[]
|
||||
|
||||
If you do not hear from reviewers after your PR longer than a week, leave a comment in PR to follow up.
|
||||
|
||||
== Docs team needs your help
|
||||
|
||||
Help us with the issues, PRs, onboarding new contributors or keeping our stock of articles as a whole up to date. Thank you!
|
||||
92
modules/ROOT/pages/contributing-docs/index.adoc
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
= Contribute to Improve and Expand Docs Articles
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revnumber: F36 and newer
|
||||
:revdate: 2023-05-01
|
||||
|
||||
:page-aliases: contributing
|
||||
|
||||
[abstract]
|
||||
____
|
||||
This document explains how to work with the publishing system used to build the Fedora Documentation website. It will guide you through contributing to existing documentation as well as creating completely new content sets and publishing them in the English originals as well as any possible translations.
|
||||
____
|
||||
|
||||
There are many different ways to contribute to Fedora documentation. Some of them are designed to enable contributions without technical knowledge about Web Content Management Systems and about how to store and manage your contribution. The tool takes over all these issues for you. It enables authors to concentrate on the topic at hand.
|
||||
|
||||
Please check us out. If you come across a documentation page that contains an error or inaccuracy, use one of the casual contribution tools described below to improve the page. If you have any questions, please do not hesitate to contact the Docs team.
|
||||
|
||||
Local authoring tools are designed to provide a powerful working environment for accomplished authors. They enable efficient work even on large complex interrelated text collections. These tools are aimed at experienced authors.
|
||||
|
||||
== How it works
|
||||
|
||||
Fedora documentation uses Antora to build and manage the Web site. Documentation is fairly static content, with occasional updates from time to time. This is exactly what Antora specializes in. It gathers static text documents and transforms them into a complete Web site, including navigation, links, formatting, positioning, adaptation to different output devices, etc. For more general information about the Antora publishing system, see the https://antora.org/[Antora website] and https://docs.antora.org/antora/latest/page/[Antora documentation].
|
||||
|
||||
As a writer, you concentrate on the content and write away.
|
||||
|
||||
=== The general procedure
|
||||
|
||||
The 4-eyes principle applies to the Fedora documentation. A different author reviews each contribution. When you complete your text or text modification, the system creates a "Pull Request" or "Merge Request" to integrate your text into the documentation body. This triggers other authors, board members or members committed to the part of the documentation body in question, to start a review and either initiates an inclusion or starts a discussion. Allow 2 to 3 days for an answer to a request.
|
||||
|
||||
=== Some technical background
|
||||
|
||||
Fedora uses _AsciiDoc_ to format text in a simple and efficient way. It closely follows natural writing styles in everyday notes for structuring and highlighting. In this way, you can use any editor, including almost any word processor that can edit and save AsciiDoc Text. More about this below.
|
||||
|
||||
The AsciiDoc text document is stored in a series of Git repositories. This is a system especially popular among software developers, but also very capable for managing text documents. Git encourages and facilitates the use of the 4-eyes principle by a "Pull (or Merge) Request Workflow". You only need to worry about the details of this workflow if you want to set up a local work environment intended for professional and frequent contributions. All other tools take care of the necessary steps in the background.
|
||||
|
||||
|
||||
== Prerequisites
|
||||
|
||||
The only requirements for contributing documentation to Fedora Docs are:
|
||||
|
||||
* link:++https://accounts.fedoraproject.org/++[*Fedora Account System*] (*FAS*) account.
|
||||
* GitLab account
|
||||
* Must have signed https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement] from FAS. To sign, go to your Fedora Account, select "Settings" by clicking your profile image in the top right corner, and then select the "Agreements" tab. Alternatively, it can be found here, substituting your actual username: https://accounts.fedoraproject.org/user/your-username/settings/agreements/
|
||||
* Basic knowledge of *AsciiDoc* markup language (see xref:contributing-docs/asciidoc-markup.adoc[AsciiDoc for Fedora])
|
||||
|
||||
|
||||
== The tools
|
||||
|
||||
=== Quick way: 'Edit' button
|
||||
|
||||
- Make changes to a single file for minor fixes directly from web UI of Git forge.
|
||||
- Write access to upstream repo required.
|
||||
- Use it as an exception (without review process), rather than a recommended option.
|
||||
|
||||
=== Easy way: Web IDE of Git forge
|
||||
|
||||
- Make changes to multiple files directly from web UI of Git forge.
|
||||
- No need to install anything in local computer or run Git commands in terminal.
|
||||
- Pull Requests for review process (Merge Requests in GitLab)
|
||||
- You do not need special permissions or write access to the original project.
|
||||
|
||||
=== Flexible and advanced way: Create a local writing environment
|
||||
|
||||
- Work with multiple files and repos offline at your pace using your choice of text editor and terminal.
|
||||
- You can build and render the pages locally to test your changes using Podman container.
|
||||
|
||||
== Typical ways to contribute
|
||||
|
||||
One can distinguish several typical types of contribution to Fedora documentation, for which the available tools are suitable in different ways.
|
||||
|
||||
There are many ways for various types of contribution. For example, typo fixes, adding short information or a link, update an article, write a new article.
|
||||
|
||||
=== Update an existing documentation page
|
||||
|
||||
This task involves minor changes. For example, typo fixes, adding short information or a link, or a correction to the text. This type is especially necessary whenever the documentation needs to be updated for a new software version.
|
||||
|
||||
The _File Edit button_ are convenient for this purpose.
|
||||
|
||||
=== Extend an existing documentation domain
|
||||
|
||||
This task involves adding one or more new chapter(s) or section(s) with several chapters. For example, adding another container technique to the documentation of containerization.
|
||||
|
||||
The _Web IDE_ is a convenient tool for this purpose. A local writing environment is useable as well, but may involve too much overhead if you want to contribute to just one document.
|
||||
|
||||
It is highly recommended to present the plan on one of the Docs communication channels before starting. You may get suggestions and tips on content, but also on editing. For example, file structure and naming conventions.
|
||||
|
||||
=== Introduce a new documentation area
|
||||
|
||||
This task involves a new extensive subject area, such as new software or a new administration tool. For example, inclusion of several sections and chapters and the creation of a new, separate repository.
|
||||
|
||||
For this type, setting up a local writing environment is useful and worthwhile.
|
||||
|
||||
In any case, a prior discussion with the Docs team is necessary, if only to create the technical prerequisites.
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Fedora Documentation Style Guide
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
2023-04-21
|
||||
|
|
@ -112,4 +109,4 @@ If the title on H1 heading is Finding and installing Linux applications, the fil
|
|||
|
||||
Check spelling and grammar:: Check your work before creating a Pull Request.
|
||||
|
||||
Check the Red Hat style guide:: Use xref:content/tools-vale-linter.adoc[Vale] to check your work to make sure it conforms to the Red Hat Style Guide.
|
||||
Check the Red Hat style guide:: Use xref:contributing-docs/tools-vale-linter.adoc[Vale] to check your work to make sure it conforms to the Red Hat Style Guide.
|
||||
|
|
@ -1,18 +1,13 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= How to edit files on the Pagure Web UI
|
||||
Hanku Lee
|
||||
:revnumber: F33 and newer
|
||||
:revdate: 2023-04-18
|
||||
|
||||
IMPORTANT: Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge]. See the updated xref:content/tools-file-edit-forge.adoc[Edit a single page in Forge] guide.
|
||||
|
||||
This section describes how to contribute to existing documentation - that is, documentation that already has been published on the website.
|
||||
Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:index.adoc[Prerequisites].
|
||||
|
||||
[TIP]
|
||||
If you are interested in contributing to Release Notes, see the xref:content/contrib-release-notes.adoc[appropriate page].
|
||||
If you are interested in contributing to Release Notes, see the xref:contributing-docs/contrib-release-notes.adoc[appropriate page].
|
||||
|
||||
Each Fedora Docs page includes an "Edit this Page" link at the top.
|
||||
For simple updates, changes can be submitted directly from the Pagure web interface.
|
||||
|
|
@ -82,7 +77,7 @@ see link:++https://commit.style++[commit.style] by Tim Pope (author of [applicat
|
|||
. If you added any new files, then ensure they are included in a reasonable spot in the repository's [filename]`nav.adoc` configuration file
|
||||
|
||||
. Build locally and make sure everything looks the way you expect.
|
||||
See xref:content/tools-localenv-preview.adoc[Building a local preview] for instructions.
|
||||
See xref:contributing-docs/tools-localenv-preview.adoc[Building a local preview] for instructions.
|
||||
|
||||
. Once you finish, commit your changes and push them to your fork.
|
||||
|
||||
|
|
@ -1,13 +1,8 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= How to make casual contributions
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revdate: 2023-26-06
|
||||
:page-pagination:
|
||||
|
||||
IMPORTANT: Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge]. See the updated xref:content/tools-file-edit-forge.adoc[Edit a single page in Forge] guide.
|
||||
|
||||
[abstract]
|
||||
To make changes in Docs page hosted on GitLab, you have a built-in web editor that makes your first contribution easier than ever. Start editing documentation on GitLab Web IDE that you can launch in one click. You do not need special permissions or write access to the original project.
|
||||
|
||||
|
|
@ -23,10 +18,9 @@ To make changes in Docs page hosted on GitLab, you have a built-in web editor th
|
|||
|
||||
- Find a Docs page you want to edit.
|
||||
- Navigate to the top right and locate three buttons.
|
||||
- Click the middle *Edit the page* button to make corrections.
|
||||
- Click the middle *edit the page* button to make corrections.
|
||||
|
||||
NOTE: The left *Page history* button forwards to the version history of the opened Docs page as a reference.
|
||||
The right *Report an issue* button is for reporting any change or update required.
|
||||
NOTE: The left button forwards to the version history of the opened Docs page as a reference. The right button *report an issue* is when you report any change or update required.
|
||||
|
||||
|===
|
||||
a|image::1CUT-changeIdentified.png[align="center",role=black-border]
|
||||
|
|
@ -108,12 +102,12 @@ Are you sure you want to checkout <branch-name>? Any unsaved changes will be los
|
|||
|
||||
=== Step 4. Edit and save changes
|
||||
|
||||
Now, make the necessary changes in Web IDE. To write with consistency, refer to xref:content/style-guide.adoc#prerequisites[The docs style guide]
|
||||
Now, make the necessary changes in Web IDE. To write with consistency, refer to xref:contributing-docs/style-guide.adoc#prerequisites[The docs style guide]
|
||||
|
||||
.Editor UI
|
||||
image::gitlab-ui/editor.png[]
|
||||
|
||||
Once you've finished, select the source control button and click the file underneath *changes*, below the *Commit & Push* button, to view your changes.
|
||||
Once you've finished, select the source control button and click the file underneath *changes* below *Commit & Push* button) to view your changes.
|
||||
|
||||
Type a commit message and click *Commit & Push*. Click No to commit to existing branch.
|
||||
|
||||
|
|
@ -1,23 +1,14 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= How to Create and Use a Local Fedora Documentation Workflow
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revdate: 2024-08-30
|
||||
:page-pagination:
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge].
|
||||
See the updated xref:content/tools-edit-local-clone.adoc[Edit from a local clone] guide.
|
||||
====
|
||||
|
||||
[abstract]
|
||||
In a local environment, you can create or edit your documents offline. You use a local git repository that contains a complete set of documents and tools to edit. After editing is complete, preview them in a local build of Docs pages. It is by far the most flexible way of working with Docs repositories, enabled by the extensive adaptation to individual work routines and work equipment. A local writing environment allows full access to all the resources you routinely use on your workstation and is therefore perfectly adaptable to your style of working. It is particularly suitable for the creation of a completely new set of documentation on a topic or for revision of an existing set of documentation. This article takes an example of the Fedora project repositories in GitLab, but the overall process can be translated for Pagure and GitHub projects.
|
||||
|
||||
== Prerequisites
|
||||
|
||||
1. You need to fulfill the basic requirements as specified in xref:index.adoc#prerequisites[Write contributions to Docs].
|
||||
1. You need to fulfill the basic requirements as specified in xref:contributing-docs/index.adoc#prerequisites[Write contributions to Docs].
|
||||
|
||||
2. The workflow uses command line tools in most steps of the process. Having some experience working in the Linux Terminal is therefore necessary or must be learned in parallel.
|
||||
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Building a local preview
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revdate: 2023-03-19
|
||||
|
|
@ -34,7 +31,7 @@ Check README.md on the landing page of projects to run the script suggested to u
|
|||
|
||||
=== How to test changes
|
||||
|
||||
Go to the directory where the cloned repo is, build, watch and preview the site by running the build scripts in the terminal.
|
||||
Go to the the directory where cloned repo is, build, watch and preview the site by running the build scripts in terminal.
|
||||
|
||||
----
|
||||
$ ./docsbuilder.sh
|
||||
|
|
@ -54,7 +51,7 @@ To use the scripts you need [application]`Podman` installed if using Fedora Linu
|
|||
|
||||
== Previewing multiple repositories
|
||||
If your work spans content in multiple repositories,
|
||||
e.g. because you xref:content/asciidoc-markup.adoc#external-antora-link[link to another repository],
|
||||
e.g. because you xref:contributing-docs/asciidoc-markup.adoc#external-antora-link[link to another repository],
|
||||
you can extend the preview by adding more repositories to `site.yml` as follows:
|
||||
|
||||
----
|
||||
|
|
@ -62,12 +59,12 @@ content:
|
|||
sources:
|
||||
- url: .
|
||||
branches: HEAD
|
||||
- url: https://forge.fedoraproject.org/docs/another-repository.git
|
||||
- url: https://pagure.io/fedora-docs/another-repository.git
|
||||
branches: main
|
||||
----
|
||||
|
||||
Correct entries to use can be found from
|
||||
https://forge.fedoraproject.org/docs/docs-fp-o/src/branch/prod/site.yml[docs-fp-o site.yml].
|
||||
https://pagure.io/fedora-docs/docs-fp-o/blob/prod/f/site.yml[docs-fp-o site.yml].
|
||||
|
||||
== Using the regular Antora scripts
|
||||
If you want to use the regular Antora build and preview workflow - follow the instructions on https://docs.antora.org/[Antora Documentation page].
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Check Your Documentation Using Vale
|
||||
= Check Your Documentation Using Vale
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
v1.1, 2024-08-30
|
||||
|
||||
[abstract]
|
||||
Vale is a command-line tool that allows you to check your writing for grammar and stylistic errors against a set of style rules. Vale codifies your style guides into a collection of Vale-compatible YAML files and it is highly customizable.
|
||||
Vale is a command-line tool that allows you to check your writing for grammar and stylistic errors against a set of style rules. Vale codifies your style guides into a collection of Vale-compatible YAML files and it is highly customizable. Fedora documentation uses the https://stylepedia.net/style/5.1/[Red Hat] style guide. Before creating a merge request for any documentation or documentation updates, you will need to run https://vale.sh[Vale] on your text.
|
||||
|
||||
== Install Vale on your computer
|
||||
== Install Vale on your computer
|
||||
|
||||
You can install Vale on your computer, or use a containerized version with Podman.
|
||||
|
||||
To install Vale on your computer use one of the available installers for https://vale.sh/docs/vale-cli/installation/[Windows, macOS, and Linux].
|
||||
|
||||
If you are using Fedora, you can install Vale from the `mczernek/vale` Copr repository. Be aware that Copr is not officially supported by Fedora infrastructure. Use packages at your own risk.
|
||||
If you are using Fedora, you can install from the `mczernek/vale` Copr repository. Be aware that Copr is not officially supported by Fedora infrastructure. Use packages at your own risk.
|
||||
|
||||
----
|
||||
$ sudo dnf copr enable mczernek/vale && sudo dnf install vale
|
||||
|
|
@ -30,27 +27,27 @@ If you installed Vale locally, verify that Vale is available by using the `vale
|
|||
|
||||
----
|
||||
$ vale -v
|
||||
vale version 2.21.2 (your version may be different depending on when you installed Vale)
|
||||
vale version 2.21.2 (your version may be different depending on when you installed Vale)
|
||||
----
|
||||
|
||||
The Red Hat style guide and the required Vale configuration files are already installed and available in the repository you forked from the main https://gitlab.com/fedora/docs[Fedora Docs] page in GitLab.
|
||||
The Red Hat style guide and the required Vale configuration files are already installed and available in the repository you forked from the main https://gitlab.com/fedora/docs[Fedora Docs] page in GitLab.
|
||||
|
||||
You can verify this by checking for a `.vale.ini` file in the file list of your fork in your GitLab account. You do not need to download or install any additional style files.
|
||||
You can verify this by checking for a `.vale.ini` file in the file list of your fork in your GitLab account. You do not need to download or install any additional style files.
|
||||
|
||||
== Use Vale to check files or directories
|
||||
|
||||
To use Vale, do the following:
|
||||
To use Vale, do the following:
|
||||
|
||||
. Create or edit a file in your local Fedora Docs repository. See xref:content/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment] for instructions on how to fork, clone, and manage Git repositories on your computer.
|
||||
. Run the Vale linter on the file. You can run Vale on a single file, several files, and directories.
|
||||
. Create or edit a file in your local Fedora Docs repository. See xref:contributing-docs/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment] for instructions on how to fork, clone, and manage Git repositories on your computer.
|
||||
. Run the Vale linter on the file. You can run Vale on a single file, several files, and directories.
|
||||
. Make updates to the file to fix any errors, warnings, or suggestions.
|
||||
. Rerun the Vale linter to verify the file passes.
|
||||
|
||||
When your file passes, you can commit your work and push to your fork on GitLab, and open a merge request.
|
||||
When your file passes, you can commit your work and push to your fork on GitLab, and open a merge request.
|
||||
|
||||
=== Vale commands and output
|
||||
|
||||
To run Vale on a single file:
|
||||
To run Vale on a single file:
|
||||
|
||||
----
|
||||
$ vale filename
|
||||
|
|
@ -62,7 +59,7 @@ To run Vale on several files:
|
|||
$ vale filename 1 filename 2
|
||||
----
|
||||
|
||||
To run Vale on all the files in a directory:
|
||||
To run Vale on all the files in a directory:
|
||||
|
||||
----
|
||||
$ vale directoryname/
|
||||
|
|
@ -71,40 +68,40 @@ $ vale directoryname/
|
|||
Vale will return a list of results showing the location in the file, the level of severity, a hint about how to correct the result, and what style reference flagged the result. For example:
|
||||
|
||||
----
|
||||
11:1 suggestion Define acronyms and RedHat.Definitions
|
||||
abbreviations (such as 'TOC')
|
||||
on first occurrence if they're
|
||||
likely to be unfamiliar.
|
||||
15:54 error Use 'for example' rather than RedHat.TermsErrors
|
||||
'e.g.'.
|
||||
15:59 warning Use correct American English RedHat.Spelling
|
||||
spelling. Did you really mean
|
||||
11:1 suggestion Define acronyms and RedHat.Definitions
|
||||
abbreviations (such as 'TOC')
|
||||
on first occurrence if they're
|
||||
likely to be unfamiliar.
|
||||
15:54 error Use 'for example' rather than RedHat.TermsErrors
|
||||
'e.g.'.
|
||||
15:59 warning Use correct American English RedHat.Spelling
|
||||
spelling. Did you really mean
|
||||
'Quickdocs'?
|
||||
----
|
||||
|
||||
If a file returns a long list of results, use:
|
||||
If a file returns a long list of results, use:
|
||||
|
||||
----
|
||||
$ vale --no-wrap filename
|
||||
----
|
||||
|
||||
This will print each result on one line. This is also useful when checking many files or all the files in a directory.
|
||||
This will print each result on one line. This is also useful when checking many files or all the files in a directory.
|
||||
|
||||
Vale has three levels of results that it will list at the bottom of the output: error, warning, and suggestion.
|
||||
Vale has three levels of results that it will list at the bottom of the output: error, warning, and suggestion.
|
||||
|
||||
`✖ 1 error, 3 warnings and 4 suggestions in 1 file.`
|
||||
`✖ 1 error, 3 warnings and 4 suggestions in 1 file.`
|
||||
|
||||
- **error**: This is a blocker, and you must fix any errors found in the file.
|
||||
- **warning**: This is a not a blocker, but is something that you need to fix to conform to the Red Hat style guide.
|
||||
- **warning**: This is a not a blocker, but is something that you need to fix to conform to the Red Hat style guide.
|
||||
- **suggestion**: This is not a blocker, but is something you must review and try to fix to conform to the Red Hat style guide.
|
||||
|
||||
If you want to only look for a specific result, use the `--minAlertLevel level` flag. This is useful if you have a long list of results and want to work on one specific result level at a time.
|
||||
If you want to only look for a specific result, use the `--minAlertLevel level` flag. This is useful if you have a long list of results and want to work on one specific result level at a time.
|
||||
|
||||
`--minAlertLevel suggestion` (shows suggestion, warning, and error)
|
||||
|
||||
`--minAlertLevel warning` (shows warning and error)
|
||||
`--minAlertLevel warning` (shows warning and error)
|
||||
|
||||
`--minAlertLevel error` (shows only error)
|
||||
`--minAlertLevel error` (shows only error)
|
||||
|
||||
For example, to only shows results flagged with error in the file, use:
|
||||
|
||||
|
|
@ -112,11 +109,11 @@ For example, to only shows results flagged with error in the file, use:
|
|||
$ vale --no-wrap --minAlertLevel error filename
|
||||
----
|
||||
|
||||
== How to interpret Vale results
|
||||
== How to interpret Vale results
|
||||
|
||||
Vale shows the results by line number and position (sometimes called a column). It also shows the style guideline that flagged the content.
|
||||
Vale shows the results by line number and position (sometimes called a column). It also shows the style guideline that flagged the content.
|
||||
|
||||
For example, this error is on line 15, starting at position 54
|
||||
For example, this error is on line 15, starting at position 54
|
||||
|
||||
----
|
||||
15:54 error Use 'for example' rather than 'e.g.'. RedHat.TermsErrors
|
||||
|
|
@ -125,36 +122,36 @@ For example, this error is on line 15, starting at position 54
|
|||
----
|
||||
15 ** Editor in chief for specific documentation areas, e.g. Quickdocs
|
||||
^ position 54
|
||||
----
|
||||
----
|
||||
|
||||
Verify that your text editor shows line numbers and position. Most text editors will have a way to enable this view.
|
||||
Verify that your text editor shows line numbers and position. Most text editors will have a way to enable this view.
|
||||
|
||||
Vale will usually tell you exactly what you need to do to fix the line, which in this case is to use 'for example' instead of 'e.g.'
|
||||
|
||||
Rerun Vale to verify that the error is now resolved. Continue running Vale to clear all errors, warnings, and suggestions.
|
||||
Rerun Vale to verify that the error is now resolved. Continue running Vale to clear all errors, warnings, and suggestions.
|
||||
|
||||
=== How to find guidance for correcting Vale results
|
||||
=== How to find guidance for correcting Vale results
|
||||
|
||||
Every result returned by Vale shows the Red Hat style reference that flagged the word or phrase. This is at the end of the each result, in the format of `RedHat.style_name`.
|
||||
Every result returned by Vale shows the Red Hat style reference that flagged the word or phrase. This is at the end of the each result, in the format of `RedHat.style_name`.
|
||||
|
||||
These files are in a `.vale` directory at the top level of your local repository, in a `styles/RedHat` subdirectory.
|
||||
These files are in a `.vale` directory at the top level of your local repository, in a `styles/RedHat` subdirectory.
|
||||
|
||||
All the style files point back to the reference guide maintained by Red Hat on the https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/reference-guide/[Vale for writers at Red Hat page].
|
||||
All the style files point back to the reference guide maintained by Red Hat on the https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/reference-guide/[Vale for writers at Red Hat page].
|
||||
|
||||
You can usually find guidance there on what to change to resolve any error or warning level results.
|
||||
You can usually find guidance there on what to change to resolve any error or warning level results.
|
||||
|
||||
If you want to see the contents of a specific style file, you can examine the https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat[vale-at-red-hat] page on GitHub.
|
||||
If you want to see the contents of a specific style file, you can examine the https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat[vale-at-red-hat] page on GitHub.
|
||||
|
||||
If you still have questions or need help deciding what changes to make, post a question in the Fedora Documentation room on https://chat.fedoraproject.org/#/room/#docs:fedoraproject.org[Fedora Chat].
|
||||
If you still have questions or need help deciding what changes to make, post a question in the Fedora Documentation room on https://chat.fedoraproject.org/#/room/#docs:fedoraproject.org[Fedora Chat].
|
||||
|
||||
== More information
|
||||
|
||||
Vale documentation: https://vale.sh/docs/
|
||||
Vale documentation: https://vale.sh/docs/
|
||||
|
||||
Red Hat Technical Writing Style Guide: https://stylepedia.net/
|
||||
Red Hat Technical Writing Style Guide: https://stylepedia.net/
|
||||
|
||||
Guidelines for Red Hat Documentation: https://redhat-documentation.github.io/
|
||||
Guidelines for Red Hat Documentation: https://redhat-documentation.github.io/
|
||||
|
||||
Fedora Docs Style Guide: https://docs.fedoraproject.org/en-US/fedora-docs/content/style-guide/
|
||||
Fedora Docs Style Guide: https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/style-guide/
|
||||
|
||||
This guide shows how to use Vale from the command line, but https://docs.gitlab.com/ee/development/documentation/testing.html#configure-editors[plugins or packages] are available for several common text editors.
|
||||
This guide shows how to use Vale from the command line, but https://docs.gitlab.com/ee/development/documentation/testing.html#configure-editors[plugins or packages] are available for several common text editors.
|
||||
|
|
@ -1,12 +1,7 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= How to use GitLab UI for more involved document maintenance
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revdate: 2023-05-13
|
||||
|
||||
IMPORTANT: Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge].
|
||||
|
||||
[abstract]
|
||||
Documentation needs maintainance as the content grows. Writers and reviewers can contribute to Docs easily and efficiently inside GitLab Web User Interface. From Web IDE, CI pipeline to collaborative review of rendered web content and approval of pages, you can work on good content and document maintenance, uninterrupted by installation and configuration. The article assumes you are already familiar with Git and continuous integration (CI).
|
||||
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Working with translations
|
||||
Fedora Documentation Team
|
||||
:revnumber: F36 and newer
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Design & UX contributions
|
||||
|
||||
[abstract]
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Contribute to keeping Docs up and running
|
||||
|
||||
22
modules/ROOT/pages/docs-team.adoc
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Who we are – The Fedora documentation team members
|
||||
|
||||
[abstract]
|
||||
____
|
||||
The Fedora Documentation Team is a large community with a large number of members, different tasks and varying degrees of cooperation.
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
TOC
|
||||
|
||||
* Basic organization
|
||||
** Maybe Core team / Editorial team
|
||||
** Editor in chief for specific documentation areas, e.g. Quickdocs
|
||||
** production line administrators
|
||||
* List of members of core team / editorieal team / arganisators, how we name it
|
||||
** Name
|
||||
** Nick name / reference to wiki personal page
|
||||
** Domain of expertise
|
||||
* List of members of other sub groups
|
||||
====
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Fedora Documentation Team
|
||||
|
||||
|
|
@ -25,7 +24,7 @@ The documentation team is a peer group with many members involved in very differ
|
|||
|
||||
And by the way, no special skills are necessary to be able to contribute. There are many ways and options to constructively doing so.
|
||||
|
||||
If you are interested in creating and shaping valuable information or would like to share your own knowledge and experience, don't hesitate to join us. And don't be afraid that you will have to make a long-term commitment at the same time. We know many different ways and intensities of contributing. See the xref:charter.adoc[team charter] for information on how we are organized.
|
||||
If you are interested in creating and shaping valuable information or would like to share your own knowledge and experience, don't hesitate to join us. And don't be afraid that you will have to make a long-term commitment at the same time. We know many different ways and intensities of contributing. See the xref::organizational/charter.adoc[team charter] for information on how we are organized.
|
||||
|
||||
=== The Board
|
||||
The Board's task is to coordinate and organize the work of the documentation team. Current members are
|
||||
|
|
@ -39,19 +38,6 @@ content writer and editor
|
|||
|
||||
Currently, we are a small but productive team. And we don’t necessarily want to be a small team in the long run. If you are interested in creating and shaping valuable information and are willing to make some commitment of regular work, please join us.
|
||||
|
||||
[[join-docs]]
|
||||
== How to join the Docs Project
|
||||
|
||||
Anyone with a link:++https://accounts.fedoraproject.org/++[FAS] account can open a pull request. However, if you would like to work with us more long-term, or maybe become a maintainer or help us with merging other contributors' pull requests, there is a formal process where you can join the Docs Project.
|
||||
|
||||
First, we would appreciate if you came and said hi to us in our Matrix channel, `#docs:fedora.im`, and made a few contributions to docs. After we get to know you a little bit, you can open an issue in the link:++https://forge.fedoraproject.org/docs/tickets/issues++[Tickets repository] and use the "New team member request" to nominate yourself. You can also have someone who is already on the team nominate you instead using the same template.
|
||||
|
||||
After you or someone else opens that issue, there is a 7 day minimum waiting period during which current team members can vote. A successful nomination requires at least 3 `+1` votes and no `-1` votes. Negative votes are extremely rare, and are handled on a case by case basis.
|
||||
|
||||
Once the nomination gains 3 "yes" votes and a week passes, we will add you to the Docs Team FAS group, which will give you a higher level of access to any docs repositories such as merging pull requests.
|
||||
|
||||
//TODO: Once we have a separate Quick Docs group, update the above to mention it as well, there's going to be a separate template
|
||||
|
||||
== Ongoing working projects
|
||||
|
||||
Migration of docs repositories::
|
||||
|
|
@ -85,26 +71,26 @@ Both distribution share a lot of code and a large number of almost identical adm
|
|||
[[find-docs]]
|
||||
== Where to find Fedora docs team
|
||||
|
||||
Please contact us at any of our communication channels:
|
||||
Please contact us at any of our communication channels.
|
||||
|
||||
Fedora discussion forum::
|
||||
https://discussion.fedoraproject.org/tag/docs-team
|
||||
|
||||
IRC channel::
|
||||
#fedora-docs on Libera IRC (largely abandoned)
|
||||
#fedora-docs on Libera IRC
|
||||
|
||||
Matrix room::
|
||||
#docs:fedora.im
|
||||
|
||||
Fortnightly Matrix meeting::
|
||||
Every other Tuesday, 13:00 UTC at #meeting:fedora.im
|
||||
+
|
||||
See link:++https://calendar.fedoraproject.org/docs/++[Fedocal] for up to date info
|
||||
////
|
||||
Weekly IRC meeting::
|
||||
Each Wednesday, 18:30 UTC at #fedora-meeting-1
|
||||
////
|
||||
|
||||
== Have a look on our working infrastructure
|
||||
|
||||
Work is tracked in multiple repositories as relevant.
|
||||
Tickets which affect the project as a whole instead of a specific repository are located in the link:++https://forge.fedoraproject.org/docs/tickets/issues++[Tickets repo].
|
||||
We track work in https://gitlab.com/groups/fedora/docs/-/boards[GitLab].
|
||||
|
||||
|
||||
== If you managed to read this far
|
||||
|
||||
17
modules/ROOT/pages/locations.adoc
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Fedora Documentation Infrastructure
|
||||
|
||||
[abstract]
|
||||
____
|
||||
The fedora docs ars stored in git repositories.
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Repositories on gitlab
|
||||
* Organization / overview of repositories including links
|
||||
* Where to find what
|
||||
* TBD
|
||||
====
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Documentation Team Charter
|
||||
|
||||
== Mission
|
||||
|
|
@ -49,8 +46,6 @@ Members are in the *docs* group in Fedora Accounts. This grants *developer*-leve
|
|||
|
||||
Members are expected to have a recent history of content and/or tooling contributions and participation in meetings and team discussions.
|
||||
|
||||
For information on how to become a member, see xref:index.adoc#join-docs[How to join the Docs Project].
|
||||
|
||||
==== Contributor
|
||||
|
||||
Contributor status is granted to all Fedora contributors.
|
||||
15
modules/ROOT/pages/organizational/index.adoc
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
include::ROOT:partial$attributes.adoc[]
|
||||
|
||||
= Team Organisation and procedures
|
||||
|
||||
[abstract]
|
||||
____
|
||||
TBD
|
||||
____
|
||||
[NOTE]
|
||||
====
|
||||
*_TOC_*
|
||||
|
||||
* Doc Teams charter
|
||||
====
|
||||
|
||||
|
|
@ -1,9 +1,6 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Communication and Meetings
|
||||
|
||||
Fedora Docs currently holds weekly meetings on Matrix in `#meeting:fedoraproject.org` (Fedora Meeting) room.
|
||||
Fedora Docs currently holds weekly meetings on IRC/Telegram/Matrix.
|
||||
See the link:++https://calendar.fedoraproject.org//docs/++[docs calendar] for current meeting times,
|
||||
and xref:index.adoc#find-docs[the main page] for information about joining.
|
||||
|
||||
|
|
@ -11,8 +8,8 @@ This page describes the structure in the meetings.
|
|||
|
||||
== Pre-meeting
|
||||
|
||||
Items to be discussed in meetings should be tagged with the link:https://forge.fedoraproject.org/docs/tickets/issues?labels=3655[Meeting] tag.
|
||||
While preparing the agenda, review the https://forge.fedoraproject.org/docs/tickets/projects/407[issue board] for items that should be tagged for the meeting.
|
||||
Items to be discussed in meetings should be tagged with the link:++https://gitlab.com/groups/fedora/docs/-/issues?label_name=Meeting++[Meeting] tag.
|
||||
While preparing the agenda, review the https://gitlab.com/groups/fedora/docs/-/boards[issue board] for items that should be tagged for the meeting.
|
||||
At least a day or two prior to the meeting, the chair should post a thread with the agenda
|
||||
on the link:++https://discussion.fedoraproject.org/tag/docs-team++[forums].
|
||||
Team members may suggest additional topics in these threads.
|
||||
|
|
@ -22,59 +19,61 @@ Team members may suggest additional topics in these threads.
|
|||
Follow this general script for the meeting.
|
||||
|
||||
```
|
||||
!startmeeting docs
|
||||
#startmeeting docs
|
||||
|
||||
!topic Roll call
|
||||
#topic Roll call
|
||||
```
|
||||
|
||||
Wait 3–5 minutes to see who is present.
|
||||
|
||||
TIP: In case you need to step away or get disconnected, add other chairs (e.g. xref:index.adoc#_the_board[board members]) with: !chair <NICK>
|
||||
TIP: In case you need to step away or get disconnected, add other chairs (e.g. xref:index.adoc#_the_board[board members]) with: #chair <NICK>
|
||||
|
||||
List the agenda for the meeting:
|
||||
|
||||
```
|
||||
!topic Agenda
|
||||
- Announcements
|
||||
- Review action items
|
||||
- <topic 1>
|
||||
- <topic 2>
|
||||
- Open Floor
|
||||
#topic Agenda
|
||||
#info Announcements
|
||||
#info Review action items
|
||||
#info <topic 1>
|
||||
#info <topic 2>
|
||||
#info …
|
||||
```
|
||||
|
||||
Start with any important announcements.
|
||||
(e.g. Release Notes that need to be written, upcoming deadlines, a link to the https://forge.fedoraproject.org/docs/tickets/projects/407[issue board], etc.)
|
||||
(e.g. Release Notes that need to be written, upcoming deadlines, a link to the https://gitlab.com/groups/fedora/docs/-/boards[issue board], etc.)
|
||||
|
||||
Next, review action items from https://meetbot.fedoraproject.org/[previous meetings].
|
||||
Next, review action items from https://meetbot.fedoraproject.org/sresults/?group_id=docs&type=team[previous meetings].
|
||||
Get updates when there are updates to get.
|
||||
If an action item is still open,
|
||||
use the `!action` command to assign it again.
|
||||
use the `#action` command to assign it again.
|
||||
This keeps chairs from having to search many previous meetings.
|
||||
|
||||
```
|
||||
!topic Previous action items
|
||||
!info <nick> was to <action>
|
||||
#topic Previous action items
|
||||
#info <nick> was to <action>
|
||||
```
|
||||
|
||||
Proceed through the other agenda topics.
|
||||
Use `!topic` to change the topic.
|
||||
Make frequent use of `!info` and `!link` commands to add context to the minutes.
|
||||
Use `#topic` to change the topic.
|
||||
Make frequent use of `#info` and `#link` commands to add context to the minutes.
|
||||
If someone needs to act,
|
||||
use `!action <nick> to <action>` to note it in the minutes.
|
||||
Note agreements with the `!agreed` command.
|
||||
To indicate you're present type `!hi`.
|
||||
use `#action <nick> to <action>` to note it in the minutes.
|
||||
Note agreements with the `#agreed` command.
|
||||
|
||||
TIP: Most of the time,
|
||||
something that is !agreed should be recorded elsewhere after the meeting.
|
||||
something that is #agreed should be recorded elsewhere after the meeting.
|
||||
For example,
|
||||
in the resolution of a ticket
|
||||
or as a new policy/procedure in the documentation.
|
||||
|
||||
NOTE: Should we add a regular content-related topic?
|
||||
https://discussion.fedoraproject.org/t/fedora-and-centos-docs-revitalization/36353/7[Peter Boy suggested this].
|
||||
|
||||
If time permits,
|
||||
open the floor for other discussion.
|
||||
|
||||
```
|
||||
!topic Open floor
|
||||
#topic Open floor
|
||||
```
|
||||
|
||||
CAUTION: Do not make decisions in the open floor section.
|
||||
|
|
@ -86,7 +85,7 @@ In most cases, decisions should happen asynchronously.
|
|||
When time is up or there are no more topics to discuss, end the meeting.
|
||||
|
||||
```
|
||||
!endmeeting
|
||||
#endmeeting
|
||||
```
|
||||
|
||||
== Post-meeting
|
||||
|
|
@ -94,5 +93,3 @@ When time is up or there are no more topics to discuss, end the meeting.
|
|||
Paste the links to the minutes and logs in the Discussion thread you used for the agenda.
|
||||
Note any important outcomes.
|
||||
Update tickets or discussion threads with actions, agreements, etc.
|
||||
|
||||
Past meeting minutes are available through https://meetbot.fedoraproject.org/.
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= The Docs Workflow organization
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revdate: 2023-04-24
|
||||
|
|
@ -3,4 +3,4 @@
|
|||
:FEDMSG: http://www.fedmsg.com/
|
||||
:FWIKI: https://fedoraproject.org/wiki
|
||||
:MATRIX: https://matrix.to/#/#docs:fedoraproject.org
|
||||
:YEAR: 2026
|
||||
:YEAR: 2022
|
||||
|
Before Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 2.2 KiB |
|
Before Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 58 KiB |
|
|
@ -1,29 +0,0 @@
|
|||
** xref:index.adoc[Contribute to Fedora Docs]
|
||||
*** xref:content/contrib-new-documentation.adoc[Create a new documentation module]
|
||||
*** xref:content/contrib-quickdocs.adoc[Contributing to Quick Docs]
|
||||
*** xref:content/contrib-release-notes.adoc[Contributing to Release Notes]
|
||||
*** xref:content/tools-file-edit-forge.adoc[Edit documentation in Forge]
|
||||
*** xref:content/tools-edit-local-clone.adoc[Edit documentation locally]
|
||||
*** xref:content/tools-vale-linter.adoc[Check edits with Vale]
|
||||
|
||||
** xref:content/style-guide.adoc[The docs style guide]
|
||||
** xref:content/asciidoc-intro.adoc[AsciiDoc for Fedora]
|
||||
*** xref:content/asciidoc-markup.adoc[Markup]
|
||||
*** xref:content/asciidoc-reusable-attributes.adoc[Reusable attributes]
|
||||
** xref:content/translations.adoc[Working with Translations]
|
||||
|
||||
** Legacy guides
|
||||
*** xref:content/tools-gitlab-howto.adoc[HowTo for casual contributions (for GitLab-based pages)]
|
||||
//*** xref:content/contributions-quick-repo.adoc[How to contribute to Quick Docs repo]
|
||||
*** xref:content/tools-web-ide-ui.adoc[How to profoundly use GitLab UI for document maintenance]
|
||||
//*** xref:content/contributions-quick-repo.adoc[How to contribute to Quick Docs repo]
|
||||
*** xref:content/tools-file-edit-pagure.adoc[How to edit files on the Pagure Web UI]
|
||||
*** xref:content/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment]
|
||||
*** xref:content/tools-localenv-preview.adoc[How to run a local preview]
|
||||
|
||||
//* Contribute to keeping Docs up and running
|
||||
* xref:maintenance/index.adoc[Contribute to keeping docs up and running]
|
||||
** xref:maintenance/design-ux-contribution.adoc[Design the user interface for Docs]
|
||||
|
||||
//* xref:archive/index.adoc[What we have achieved so far]
|
||||
//* What we have achieved so far
|
||||
|
|
@ -1,227 +0,0 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Edit Documentation Locally
|
||||
:revdate: 2026-04-01
|
||||
:page-pagination:
|
||||
Jocelyn Gould (korora) and Eli Ridge (egret)
|
||||
|
||||
This guide will show you how to set up a local documentation editing environment on your computer, using a local clone.
|
||||
|
||||
Editing locally allows you to make complex edits to multiple pages simultaneously.
|
||||
It also allows you to preview edits exactly as they will appear once published on the main docs site.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
This guide deals only with repositories (repos) hosted on Fedora Forge.
|
||||
The process will differ for repos hosted on GitLab, GitHub, or Pagure.
|
||||
You can find the legacy guides for the previously used hosting platforms in the _contribution tools_ section of this website.
|
||||
====
|
||||
|
||||
For explanations and references on the Fedora Docs tooling, please visit the xref:index.adoc[Contribute to Fedora docs] page.
|
||||
|
||||
//above links to the current live page not the update draft.
|
||||
|
||||
== Prerequisites
|
||||
|
||||
* xref:index.adoc#_prerequisites[*Prerequisites for Contributing to Docs*] section completed.
|
||||
* *Git* installed.
|
||||
+
|
||||
In Fedora Linux, you can check that _git_ is installed by running the following command:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ dnf install git
|
||||
----
|
||||
* *Text editor* of choice installed.
|
||||
+
|
||||
It is beneficial, but not essential, if your text editor has integrated file navigation, a terminal, and AsciiDoc syntax support.
|
||||
|
||||
== Set up a local editing environment
|
||||
|
||||
1. *Create a local subdirectory* where your local clone will be stored.
|
||||
The example uses the name "fedora-docs" but you can use any name.
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ mkdir ~/fedora-docs
|
||||
$ cd ~/fedora-docs
|
||||
----
|
||||
|
||||
|
||||
2. Use the Forge web interface to fork the repo you intend to edit.
|
||||
Click the Fork button on the top-right corner of the project page:
|
||||
+
|
||||
image::fork-button.png[]
|
||||
+
|
||||
If prompted, enter the details to create your new fork.
|
||||
The default values are suitable in most cases.
|
||||
|
||||
3. Configure your Forge access token and clone your remote fork to your computer.
|
||||
Follow the xref:forge-documentation::using_http_auth.adoc[How to clone a Forge repo using the HTTPS] guide to complete this.
|
||||
|
||||
4. Configure the upstream repo in your local clone.
|
||||
You will need this to fetch updates from the upstream main docs repo.
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git remote add upstream https://forge.fedoraproject.org/docs/<name-of-upstream-repo>.git
|
||||
----
|
||||
+
|
||||
Verify it with:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git remote -v
|
||||
----
|
||||
+
|
||||
The exact URLs may differ.
|
||||
But check that you have two origin entries that match your fork, and two upstream entries that match the upstream main docs repo URL.
|
||||
The output will resemble this:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
origin https://forge.fedoraproject.org/<forge-user-name>/<reponame>.git (fetch)
|
||||
origin https://forge.fedoraproject.org/<forge-user-name>/<reponame>.git (push)
|
||||
upstream https://forge.fedoraproject.org/docs/<reponame>.git (fetch)
|
||||
upstream https://forge.fedoraproject.org/docs/<reponame>.git (push)
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The terms _origin_ and _upstream_ are not strict descriptors but commonly used names to refer to your fork and the upstream fork respectively.
|
||||
So you can choose different names to represent the two repos if you wish.
|
||||
====
|
||||
|
||||
5. Create a working branch:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git checkout -b <branch-name-you-choose>
|
||||
----
|
||||
|
||||
See xref:content/tools-edit-local-clone.adoc#_branching[here] for further information on branching.
|
||||
|
||||
You are now ready to start writing.
|
||||
Consider making use of the xref:content/style-guide.adoc[Fedora style guide] as well as the xref:content/tools-vale-linter.adoc[Vale] tool to assist your editing.
|
||||
|
||||
== Edit the AsciiDoc code
|
||||
|
||||
You can open and edit AsciiDoc files with any text editor.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Some text editors will provide three panes by default, and some will not show more than just the contents of the file that you are currently working on.
|
||||
Many graphical editors provide at least the folder structure and the .adoc file contents view at the same time; terminal editors will usually only show the contents of the .adoc file and may require either a second terminal window open or exiting the editor in order to run commands.
|
||||
====
|
||||
|
||||
As an example configuration, you can use your text editor or IDE of choice with the following three viewing panes:
|
||||
|
||||
* project folder structure.
|
||||
* project terminal window open at `username@device:~/fedora-docs/name-of-project`.
|
||||
|
||||
* .adoc file contents window.
|
||||
|
||||
The above layout allows you to quickly select files, make edits, and issue git and preview commands, all within the same tool.
|
||||
|
||||
== Preview your work
|
||||
|
||||
The _docsbuilder_ script uses Podman to build a preview of your docs pages in an isolated container.
|
||||
|
||||
. In the terminal, navigate to your project folder.
|
||||
Run the _docsbuilder_ script by entering this command:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ ./docsbuilder.sh
|
||||
----
|
||||
+
|
||||
A successful output will resemble this:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
...
|
||||
Watching current directory (excluding: build/|cache/|preview.pid|public/|\.git.*|4913) for changes and re-building as required. Use Ctrl C to stop.
|
||||
Serving HTTP on 0.0.0.0 port 8080 (http://0.0.0.0:8080/) ...
|
||||
----
|
||||
|
||||
. In a browser, visit http://localhost:8080.
|
||||
|
||||
. To update the preview after further edits:
|
||||
.. Ensure the script is at rest - the terminal window activity should have stopped and the last sentence read `Watching current directory...`.
|
||||
.. Save the .adoc file you have been editing and observe the script complete again.
|
||||
.. Refresh the browser window.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
On MacOS, the _docsbuilder_ script uses Docker instead of Podman.
|
||||
You can install Docker from the official https://www.docker.com/[Docker Website].
|
||||
====
|
||||
|
||||
See xref:content/tools-edit-local-clone.adoc#_the_docsbuilder_script_and_podman[here] for further information on the docsbuilder script.
|
||||
|
||||
== Pushing your changes to your remote fork on Forge
|
||||
|
||||
1. Determine the files that have been changed and added to the branch you are working on:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git status
|
||||
----
|
||||
+
|
||||
The files in the output are known as 'untracked files', meaning that git has no idea what to do with these files or if you want them to be included in your commit.
|
||||
|
||||
2. Add the changed files to your local git staging ground:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git add <path-to-changed-file>
|
||||
----
|
||||
|
||||
3. Commit with a message:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git commit -m <meaningful-name-reflecting-what-you-changed>
|
||||
----
|
||||
|
||||
4. Push your changes:
|
||||
+
|
||||
[source,console]
|
||||
----
|
||||
$ git push origin <branch-name>
|
||||
----
|
||||
|
||||
You are now ready to open a pull request (PR).
|
||||
|
||||
== PR checklist
|
||||
* [ ] Spelling and grammar checked.
|
||||
|
||||
* [ ] Metadata and author tags entered.
|
||||
|
||||
* [ ] Tested and previewed using the s/docsbuilder/docsbuilder.sh/ script.
|
||||
|
||||
== Opening a pull request
|
||||
|
||||
On the Forge web interface, navigate to your fork's repo and the branch you have been working on.
|
||||
Click on the _New Pull Request_ button.
|
||||
|
||||
== Explanations
|
||||
|
||||
=== Branching
|
||||
|
||||
At its most basic level, branching is simply taking a snapshot of the main line of the repo and making changes to that branch.
|
||||
This keeps what you're working on separate from what others are working on and allows for multiple changes to be merged into the main branch.
|
||||
After you have made your changes to the files and committed those changes to your origin repo, you can then open a pull request to have your changes merged into the main branch and published on the docs site.
|
||||
|
||||
=== The docsbuilder script and Podman
|
||||
|
||||
The _docsbuilder_ script is present in your local clone's project folder by default.
|
||||
Running the script starts the Antora static site generator locally on your device within an isolated container.
|
||||
There is no requirement to install Antora or any other web development tools on your device.
|
||||
|
||||
Podman is an open source container tool similar to Docker.
|
||||
When you run the docsbuilder.sh script, Podman will download the Antora parser to your local machine as a container.
|
||||
Once you are done with the container, if you wish to remove it, simply run ``podman image rm antora``.
|
||||
There is no harm in leaving the container on your system if you are working on a lot of docs.
|
||||
This will allow you to save some bandwidth on the hosting server for the image.
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Edit a Page Using the Forge Web Interface
|
||||
Eli R
|
||||
:revnumber: F43 and newer
|
||||
:revdate: 2026-04-04
|
||||
|
||||
This section will guide you through editing a documentation (docs) page using the Fedora Forge web interface.
|
||||
|
||||
Use this method for small changes, such as fixing typos or other simple edits that affect a single page.
|
||||
|
||||
== Preparation
|
||||
|
||||
* Complete the contributor https://docs.fedoraproject.org/en-US/fedora-docs/content/#_prerequisites[*prerequisites*].
|
||||
|
||||
== Edit via the Forge web interface
|
||||
|
||||
Every documentation page has an icon:edit[] *Edit this page* button in the top right corner.
|
||||
Use this to locate the page's source repository on Fedora Forge.
|
||||
|
||||
Starting from the docs.fedoraproject.org page that you intend to edit:
|
||||
|
||||
1. Click the icon:edit[] *Edit* button in the top right corner to navigate to the source page.
|
||||
|
||||
2. If you are not already signed in, do so with your FAS account.
|
||||
|
||||
3. Click the *Fork* button (normally top right). If prompted, enter the details to create your new fork. The default values are suitable in most cases.
|
||||
+
|
||||
IMPORTANT: If you receive a warning that the branch is behind in commits, click the _Sync_ button so that it matches the upstream repo.
|
||||
|
||||
4. Manually navigate the folder structure to return to the source page you intend to edit (normally in modules/ROOT/pages/).
|
||||
|
||||
5. Click the icon:pen[] *Edit* button, located on the right side above the file contents, and make your changes directly to the AsciiDoc code.
|
||||
|
||||
6. Use the icon:eye[] *Preview* button, located on the left side above the edit field, to see how the document will look. Keep in mind that some AsciiDoc elements may not render accurately in the preview.
|
||||
|
||||
7. Once you are happy with the edit, scroll to the bottom of the page, and optionally add a message describing the nature of the edit.
|
||||
|
||||
8. Check "Create a *new branch* for this commit and start a pull request". Optionally, rename the new branch.
|
||||
|
||||
9. Click *propose file change*, which brings you to the *New pull request* page
|
||||
|
||||
10. Use the first drop-down selector, *merge into*, to select the upstream repo. This is normally the *main* branch, but check with the repository maintainers if in doubt.
|
||||
|
||||
11. Ensure the *pull from* selector is set to your personal fork, on the newly created branch from step 8.
|
||||
|
||||
12. Click *New pull request*.
|
||||
|
||||
13. Carry out any final checks, then click *Create pull request*.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
It may take a number of days before your pull request is reviewed. If you have not received a response within five days of opening the PR, consider using Matrix to reach out to the team that is responsible for that repo.
|
||||
====
|
||||
|
|
@ -1,160 +0,0 @@
|
|||
include::partial$attributes.adoc[]
|
||||
:experimental:
|
||||
|
||||
= Contribute to Fedora Documentation
|
||||
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
|
||||
:revdate: 2026-06-26
|
||||
|
||||
:page-aliases: contributing:index.adoc
|
||||
:fedora-chat-url: https://matrix.to/#/#docs:fedoraproject.org?web-instance%5Belement.io%5D=chat.fedoraproject.org
|
||||
|
||||
|
||||
[abstract]
|
||||
____
|
||||
Welcome to the Fedora Documentation Team.
|
||||
If this is your first time contributing to an open source project, Fedora Documentation is an excellent place to start.
|
||||
Whether you’re an experienced contributor or just getting started, your input is valuable and highly appreciated.
|
||||
|
||||
This page will explain the documentation tools we use and our review process.
|
||||
____
|
||||
|
||||
== The purpose of documentation
|
||||
|
||||
Why do we write documentation?
|
||||
Essentially, it is to help users get tasks done.
|
||||
If a Fedora Linux user can complete a task faster, more efficiently, or with greater ease, we are achieving our goal.
|
||||
Good documentation is critical to the success of an open source project.
|
||||
|
||||
== What skills do I need?
|
||||
|
||||
If you have some basic knowledge of Git and the AsciiDoc markup language, you are ready to go.
|
||||
If not, take a few minutes to read xref:content/asciidoc-markup.adoc[AsciiDoc for Fedora].
|
||||
AsciiDoc and Git are easy to learn with time.
|
||||
|
||||
Okay, you are ready to start contributing to Fedora Docs - what next?
|
||||
|
||||
== First steps
|
||||
|
||||
* Create a link:++https://accounts.fedoraproject.org/++[*Fedora Account System*] (*FAS*) account
|
||||
* Join our {fedora-chat-url}[Matrix channel] to say hello
|
||||
* Sign the xref:legal::fpca.adoc[Fedora Project Contributor Agreement].
|
||||
To sign the agreement, go to your link:++https://accounts.fedoraproject.org/++[*Fedora Account*], select "Settings" by clicking your profile image in the top right corner, and then select the "Agreements" tab. Alternatively, it can be found here, substituting your actual username: https://accounts.fedoraproject.org/user/your-username/settings/agreements/
|
||||
* Pick a https://forge.fedoraproject.org/docs/tickets/issues[docs issue], or bring your own docs issue, and get involved.
|
||||
We welcome all types of contributions, big or small.
|
||||
|
||||
|
||||
=== The contributor journey
|
||||
Figure 1 provides an example overview of a contributor's journey.
|
||||
|
||||
.Example journey
|
||||
image::int-journey.png[]
|
||||
|
||||
== How the docs work
|
||||
|
||||
=== Repositories
|
||||
|
||||
Fedora documentation comprises around 60 git repositories (repos), often with a different team responsible for a given repo.
|
||||
The repos are hosted across Fedora Forge, GitLab, and GitHub.
|
||||
Previously there was also content hosted on Pagure and the Fedora wiki.
|
||||
Many of the repos have now been migrated to Forge.
|
||||
|
||||
==== How to locate a repo
|
||||
|
||||
To locate a page's source repo, press the edit button: icon:edit[] - located on the upper right side of the documentation page itself.
|
||||
|
||||
==== Forks
|
||||
|
||||
A fork is your very own, personal copy of the main upstream repo.
|
||||
All editing is done within a fork.
|
||||
This allows you to make edits and experiment with the repo without it having any effect on the main upstream repo.
|
||||
By design, most contributors will not have access to commit changes directly to the main upstream repo.
|
||||
|
||||
==== Branches
|
||||
|
||||
A branch is a distinct line of development within a repo.
|
||||
It provides a reference point for a specific area that you are working on, and it means that edits on one branch will not affect another.
|
||||
The majority of the upstream repos have only a single branch, the 'main' branch.
|
||||
Some repos use branches for version control, i.e. documentation that applies only to a single release version of Fedora Linux.
|
||||
|
||||
=== Website
|
||||
Antora, a static site generator (SSG), pulls source content from the repos and generates the Fedora Documentation website, illustrated in Figure 2.
|
||||
|
||||
.Website basics
|
||||
image::int-antora-site.png[]
|
||||
|
||||
The reason Antora is used is because it excels at compiling from multiple source repos to generate a unified site.
|
||||
|
||||
=== Source pages
|
||||
|
||||
Documentation text is written in the _AsciiDoc_ markup language.
|
||||
AsciiDoc is used because it is the native language of the Antora SSG.
|
||||
It closely follows natural writing styles in everyday notes for structuring and highlighting.
|
||||
AsciiDoc can be written with almost any text editor or word processor.
|
||||
|
||||
== About our review process
|
||||
|
||||
Fedora documentation follows the 4-eyes policy, meaning a second person (the second set of eyes) must review and approve a documentation change/addition before it can be merged to the main site.
|
||||
We do this to maintain accuracy and consistency across our documentation.
|
||||
|
||||
Opening a "Pull Request" (PR) initiates the review process.
|
||||
Reviewers will check for grammar, technical accuracy, style, and completeness.
|
||||
This will normally lead to the new or amended text being merged to the documentation website or a discussion on improvements.
|
||||
|
||||
The flow of the review process is illustrated in Figure 3.
|
||||
|
||||
.General review process
|
||||
image::int-review.png[]
|
||||
|
||||
=== Timeline for review
|
||||
|
||||
We aim to review and respond to PRs within seven days. If you haven't received a response within two weeks, please feel free to send a friendly reminder in our {fedora-chat-url}[Matrix channel].
|
||||
|
||||
== Editing approaches
|
||||
|
||||
There are two options for editing: locally on your machine, and directly on the Forge web interface.
|
||||
Both approaches have different strengths and weaknesses.
|
||||
Here is a comparison:
|
||||
|
||||
=== Locally
|
||||
|
||||
Editing locally allows you to:
|
||||
|
||||
- Edit large sections or even entirely new modules
|
||||
- See a live preview of your work exactly as it will appear in the final product.
|
||||
- Work on multiple files and repos at once.
|
||||
|
||||
While there is a lot to learn when editing locally, the power and flexibility it provides will be rewarding.
|
||||
|
||||
Refer to the xref:content/tools-edit-local-clone.adoc[Local workflow] guide for further information.
|
||||
|
||||
=== Forge web interface
|
||||
|
||||
Edits can be made directly on the Forge web interface. These are best suited for:
|
||||
|
||||
- updating small sections
|
||||
- adding or modifying links
|
||||
- typo and grammar fixes
|
||||
|
||||
This approach means you don't have to install any new tools on your machine.
|
||||
It also does not require use of the terminal.
|
||||
However, it has some limitations if making larger changes. It does not allow a true test preview of the pages. Images and cross references are not compiled correctly.
|
||||
|
||||
Refer to the xref:content/tools-file-edit-forge.adoc[Edit a single page in Forge] guide for further information.
|
||||
|
||||
|
||||
== Contribution types
|
||||
|
||||
Some examples of contributions include:
|
||||
|
||||
- correcting small errors
|
||||
- adding, removing, and modifying links
|
||||
- revising existing pages
|
||||
- writing new pages
|
||||
- translation
|
||||
- general ideas to improve the docs
|
||||
|
||||
== Larger contributions
|
||||
|
||||
The smaller a PR, the easier and quicker it is to review.
|
||||
If you would like to complete a major revision of a page, or write an entirely new page or section, reach out to us on the Fedora Documentation {fedora-chat-url}[Matrix channel].
|
||||
This helps to ensure your time is wisely spent and allows others to weigh in on the direction that we take together as a project.
|
||||
|
Before Width: | Height: | Size: 320 KiB |
|
|
@ -1,4 +0,0 @@
|
|||
* How we work
|
||||
** xref:charter.adoc[The Docs Charter]
|
||||
** xref:meetings.adoc[Docs Meetings]
|
||||
** xref:workflow.adoc[Docs Workflow organization]
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
:COMMBLOG: https://communityblog.fedoraproject.org
|
||||
:MAILING-LIST: https://discussion.fedoraproject.org/tag/docs
|
||||
:FEDMSG: http://www.fedmsg.com/
|
||||
:FWIKI: https://fedoraproject.org/wiki
|
||||
:MATRIX: https://matrix.to/#/#docs:fedoraproject.org
|
||||
:YEAR: 2026
|
||||
4
site.yml
|
|
@ -1,6 +1,6 @@
|
|||
site:
|
||||
title: Fedora Documentation Team
|
||||
start_page: fedora-docs:team-info:index.adoc
|
||||
title: Documentation Team's Üproject Page
|
||||
start_page: fedora-docs::index.adoc
|
||||
content:
|
||||
sources:
|
||||
- url: .
|
||||
|
|
|
|||