1
0
Fork 0
forked from docs/team-docs

Restructure the repo to split team info from contributing guide (#63)

Fixes #55

The guide is now split into 2 modules:

* `team-info`, which contains our team information
* `contributing`, which contains the actual contributing guide

Each has its own navfile etc. Configs have all been updates so that outwardly, everything looks like it did before (although I did shuffle the table of contents a little bit based on @pboy's suggestions in #55). The default index is now `team-info/index.adoc` (see `antora.yml`); that's the one you'll see when you build the guide - it's the original index.

I also made sure each file has an include for the attributes file and `:experimental:` at the top, and cleaned up the config YMLs a little bit.

Reviewed-on: docs/team-docs#63
Reviewed-by: Jan Kuparinen <copperi@noreply.forge.fedoraproject.org>
This commit is contained in:
Petr Bokoč 2026-08-27 05:59:44 +00:00 • committed by Petr Bokoč
commit a73e35bcb6
86 changed files with 150 additions and 256 deletions

View file

@ -3,14 +3,15 @@
name: fedora-docs
# Title will be visible on the page.
title: Fedora Docs Team
title: Fedora Documentation 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: master
version: ~
# 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: ROOT:index.adoc
start_page: team-info:index.adoc
# This lists all the menu definitions of your component.
nav:
- modules/ROOT/nav.adoc
- modules/team-info/nav.adoc
- modules/contributing/nav.adoc

View file

@ -1,39 +0,0 @@
//* 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 Fedora Docs]
// 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]
** How-to guides
*** xref:contributing-docs/tools-file-edit-forge.adoc[Edit a single page in Forge]
*** xref:contributing-docs/tools-edit-local-clone.adoc[Edit locally]
*** xref:contributing-docs/tools-vale-linter.adoc[Check edits with Vale]
** Legacy guides
*** xref:contributing-docs/tools-gitlab-howto.adoc[HowTo for casual contributions (for GitLab-based pages)]
//*** xref:contributing-docs/contributions-quick-repo.adoc[How to contribute to Quick Docs repo]
*** 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/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

View file

@ -1,17 +0,0 @@
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?)
====

View file

@ -1,16 +0,0 @@
include::ROOT:partial$attributes.adoc[]
= Archive
[abstract]
____
TBD
____
[NOTE]
====
*_TOC_*
* Documentation of work we have done over years
** Pre Antora docs (Fedora 1 - 2?)
====

View file

@ -1,82 +0,0 @@
= How to contribute to Quick Docs repo
Hanku Lee, Peter Boy; Fedora Documentation Team
:revdate: 2023-03-19
[abstract]
Fedora Forge 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 Forge 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://forge.fedoraproject.org/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 Forge User Interface
- Go to your forked project and click *View Fork* on top right of Quick Docs project landing page: https://forge.fedoraproject.org/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 Forge.
.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!

View file

@ -1,22 +0,0 @@
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
====

View file

@ -1,17 +0,0 @@
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
====

View file

@ -1,15 +0,0 @@
include::ROOT:partial$attributes.adoc[]
= Team Organisation and procedures
[abstract]
____
TBD
____
[NOTE]
====
*_TOC_*
* Doc Teams charter
====

View file

Before

Width:  |  Height:  |  Size: 261 KiB

After

Width:  |  Height:  |  Size: 261 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 5.4 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 161 KiB

After

Width:  |  Height:  |  Size: 161 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 326 KiB

After

Width:  |  Height:  |  Size: 326 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 313 KiB

After

Width:  |  Height:  |  Size: 313 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 230 KiB

After

Width:  |  Height:  |  Size: 230 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 237 KiB

After

Width:  |  Height:  |  Size: 237 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 254 KiB

After

Width:  |  Height:  |  Size: 254 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 318 KiB

After

Width:  |  Height:  |  Size: 318 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 298 KiB

After

Width:  |  Height:  |  Size: 298 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 221 KiB

After

Width:  |  Height:  |  Size: 221 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 222 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 224 KiB

After

Width:  |  Height:  |  Size: 224 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 249 KiB

After

Width:  |  Height:  |  Size: 249 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 197 KiB

After

Width:  |  Height:  |  Size: 197 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 297 KiB

After

Width:  |  Height:  |  Size: 297 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 173 KiB

After

Width:  |  Height:  |  Size: 173 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 90 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 320 KiB

After

Width:  |  Height:  |  Size: 320 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 90 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 108 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 59 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 81 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 91 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 180 KiB

After

Width:  |  Height:  |  Size: 180 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 138 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 153 KiB

After

Width:  |  Height:  |  Size: 153 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 136 KiB

After

Width:  |  Height:  |  Size: 136 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 55 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 186 KiB

After

Width:  |  Height:  |  Size: 186 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Before After
Before After

View file

@ -0,0 +1,29 @@
** 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

View file

@ -1,3 +1,6 @@
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

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= AsciiDoc markup
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
v1.0, 2022-12-10

View file

@ -1,7 +1,9 @@
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.
@ -92,7 +94,7 @@ Placing this macro on the top line will do the rest:
[source,adoc]
----
\include::ROOT:partial$attributes.adoc[]
\include::partial$attributes.adoc[]
----

View file

@ -1,10 +1,13 @@
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:contributing-docs/contrib-release-notes.adoc[appropriate page].
If you are interested in contributing to Release Notes, see the xref:content/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.
@ -74,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:contributing-docs/tools-localenv-preview.adoc[Building a local preview] for instructions.
See xref:content/tools-localenv-preview.adoc[Building a local preview] for instructions.
. Once you finish, commit your changes and push them to your fork.

View file

@ -1,4 +1,5 @@
include::ROOT:partial$attributes.adoc[]
include::partial$attributes.adoc[]
:experimental:
= Create a new documentation module
Francois Andrieu, Fedora Documentation Team
@ -9,7 +10,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:contributing-docs/index.adoc#_prerequisites[Prerequisites].
Before you start following this procedure, review all the requirements listed in xref:index.adoc#_prerequisites[Prerequisites].
== Documentation repository configuration
@ -49,12 +50,12 @@ At this point, the initial configuration is complete. You can push these changes
Some useful documentation links:
- xref:contributing-docs/asciidoc-markup.adoc[]
- xref:contributing-docs/style-guide.adoc[]
- xref:content/asciidoc-markup.adoc[]
- xref:content/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:contributing-docs/tools-localenv-preview.adoc[local preview] to check the resulting document.
While you're writing, you can use the xref:content/tools-localenv-preview.adoc[local preview] to check the resulting document.
== Publish a new documentation module

View file

@ -1,7 +1,10 @@
include::partial$attributes.adoc[]
:experimental:
= Contributing to Quick Docs
Hanku Lee; Peter Boy; Fedora Documentation Team
:revdate: 2023-03-19
:page-aliases: contributing-docs/contributions-quick-repo.adoc
:page-aliases: content/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.
@ -71,7 +74,7 @@ The second link opens a web editor, you can use to enter proposed modifications
.The web editor
image::contrib-quickdocs/report-issue.png[]
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].
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].
== How to contribute
@ -117,7 +120,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: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].
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].
=== Rule sets
@ -132,7 +135,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:contributing-docs/tools-vale-linter.adoc#prerequisites[How to check documentation style with Vale]
xref:content/tools-vale-linter.adoc#prerequisites[How to check documentation style with Vale]

View file

@ -1,4 +1,5 @@
include::ROOT:partial$attributes.adoc[]
include::partial$attributes.adoc[]
:experimental:
= Contributing to Release Notes
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
@ -11,7 +12,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:contributing-docs/contributing-to-existing-docs.adoc[appropriate page].
//xref:content/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.
@ -50,6 +51,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:contributing-docs/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:content/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].

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Fedora Documentation Style Guide
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
2023-04-21
@ -109,4 +112,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:contributing-docs/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:content/tools-vale-linter.adoc[Vale] to check your work to make sure it conforms to the Red Hat Style Guide.

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Edit Documentation Locally
:revdate: 2026-04-01
:page-pagination:
@ -15,13 +18,13 @@ 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:contributing-docs/index.adoc[Contribute to Fedora docs] page.
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:contributing-docs/index.adoc#_prerequisites[*Prerequisites for Contributing to Docs*] section completed.
* 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:
@ -97,10 +100,10 @@ So you can choose different names to represent the two repos if you wish.
$ git checkout -b <branch-name-you-choose>
----
See xref:contributing-docs/tools-edit-local-clone.adoc#_branching[here] for further information on branching.
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:contributing-docs/style-guide.adoc[Fedora style guide] as well as the xref:contributing-docs/tools-vale-linter.adoc[Vale] tool to assist your editing.
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
@ -155,7 +158,7 @@ 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:contributing-docs/tools-edit-local-clone.adoc#_the_docsbuilder_script_and_podman[here] for further information on the docsbuilder script.
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

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Edit a Page Using the Forge Web Interface
Eli R
:revnumber: F43 and newer
@ -9,7 +12,7 @@ Use this method for small changes, such as fixing typos or other simple edits th
== Preparation
* Complete the contributor https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/#_prerequisites[*prerequisites*].
* Complete the contributor https://docs.fedoraproject.org/en-US/fedora-docs/content/#_prerequisites[*prerequisites*].
== Edit via the Forge web interface

View file

@ -1,15 +1,18 @@
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:contributing-docs/tools-file-edit-forge.adoc[Edit a single page in Forge] guide.
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:contributing-docs/contrib-release-notes.adoc[appropriate page].
If you are interested in contributing to Release Notes, see the xref:content/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.
@ -79,7 +82,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:contributing-docs/tools-localenv-preview.adoc[Building a local preview] for instructions.
See xref:content/tools-localenv-preview.adoc[Building a local preview] for instructions.
. Once you finish, commit your changes and push them to your fork.

View file

@ -1,9 +1,12 @@
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:contributing-docs/tools-file-edit-forge.adoc[Edit a single page in Forge] guide.
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.
@ -104,7 +107,7 @@ 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:contributing-docs/style-guide.adoc#prerequisites[The docs style guide]
Now, make the necessary changes in Web IDE. To write with consistency, refer to xref:content/style-guide.adoc#prerequisites[The docs style guide]
.Editor UI
image::gitlab-ui/editor.png[]

View file

@ -1,3 +1,6 @@
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
@ -6,7 +9,7 @@ Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
[IMPORTANT]
====
Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge].
See the updated xref:contributing-docs/tools-edit-local-clone.adoc[Edit from a local clone] guide.
See the updated xref:content/tools-edit-local-clone.adoc[Edit from a local clone] guide.
====
[abstract]
@ -14,7 +17,7 @@ In a local environment, you can create or edit your documents offline. You use a
== Prerequisites
1. You need to fulfill the basic requirements as specified in xref:contributing-docs/index.adoc#prerequisites[Write contributions to Docs].
1. You need to fulfill the basic requirements as specified in xref: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.

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Building a local preview
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
:revdate: 2023-03-19
@ -51,7 +54,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:contributing-docs/asciidoc-markup.adoc#external-antora-link[link to another repository],
e.g. because you xref:content/asciidoc-markup.adoc#external-antora-link[link to another repository],
you can extend the preview by adding more repositories to `site.yml` as follows:
----

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Check Your Documentation Using Vale
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
v1.1, 2024-08-30
@ -38,7 +41,7 @@ You can verify this by checking for a `.vale.ini` file in the file list of your
To use Vale, do the following:
. 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.
. 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.
. Make updates to the file to fix any errors, warnings, or suggestions.
. Rerun the Vale linter to verify the file passes.
@ -152,6 +155,6 @@ Red Hat Technical Writing Style Guide: https://stylepedia.net/
Guidelines for Red Hat Documentation: https://redhat-documentation.github.io/
Fedora Docs Style Guide: https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/style-guide/
Fedora Docs Style Guide: https://docs.fedoraproject.org/en-US/fedora-docs/content/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.

View file

@ -1,3 +1,6 @@
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

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Working with translations
Fedora Documentation Team
:revnumber: F36 and newer

View file

@ -1,8 +1,11 @@
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
:page-aliases: contributing:index.adoc
:fedora-chat-url: https://matrix.to/#/#docs:fedoraproject.org?web-instance%5Belement.io%5D=chat.fedoraproject.org
@ -25,7 +28,7 @@ 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:contributing-docs/asciidoc-markup.adoc[AsciiDoc for Fedora].
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?
@ -122,7 +125,7 @@ Editing locally allows you to:
While there is a lot to learn when editing locally, the power and flexibility it provides will be rewarding.
Refer to the xref:contributing-docs/tools-edit-local-clone.adoc[Local workflow] guide for further information.
Refer to the xref:content/tools-edit-local-clone.adoc[Local workflow] guide for further information.
=== Forge web interface
@ -136,7 +139,7 @@ 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:contributing-docs/tools-file-edit-forge.adoc[Edit a single page in Forge] guide for further information.
Refer to the xref:content/tools-file-edit-forge.adoc[Edit a single page in Forge] guide for further information.
== Contribution types
@ -155,4 +158,3 @@ Some examples of contributions include:
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.

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Design & UX contributions
[abstract]

View file

@ -1,4 +1,5 @@
include::ROOT:partial$attributes.adoc[]
include::partial$attributes.adoc[]
:experimental:
= Contribute to keeping Docs up and running

View file

@ -3,4 +3,4 @@
:FEDMSG: http://www.fedmsg.com/
:FWIKI: https://fedoraproject.org/wiki
:MATRIX: https://matrix.to/#/#docs:fedoraproject.org
:YEAR: 2022
:YEAR: 2026

Binary file not shown.

After

Width:  |  Height:  |  Size: 320 KiB

View file

@ -0,0 +1,4 @@
* How we work
** xref:charter.adoc[The Docs Charter]
** xref:meetings.adoc[Docs Meetings]
** xref:workflow.adoc[Docs Workflow organization]

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= Documentation Team Charter
== Mission

View file

@ -1,4 +1,5 @@
include::ROOT:partial$attributes.adoc[]
include::partial$attributes.adoc[]
:experimental:
= Fedora Documentation Team
@ -24,7 +25,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::organizational/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: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

View file

@ -1,3 +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.

View file

@ -1,3 +1,6 @@
include::partial$attributes.adoc[]
:experimental:
= The Docs Workflow organization
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs-team>
:revdate: 2023-04-24

View file

@ -0,0 +1,6 @@
: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

View file

@ -1,6 +1,6 @@
site:
title: Documentation Team's Üproject Page
start_page: fedora-docs::index.adoc
title: Fedora Documentation Team
start_page: fedora-docs:team-info:index.adoc
content:
sources:
- url: .