fix links

This commit is contained in:
darknao 2022-08-30 16:17:25 +02:00 • committed by py0xc3
commit 9d7015601d
8 changed files with 12 additions and 12 deletions

View file

@ -33,7 +33,7 @@ The only requirements for contributing documentation to Fedora Docs are:
* link:++https://admin.fedoraproject.org/accounts/++[*Fedora Account System*] (*FAS*) account.
* Must have signed https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement] from FAS (see https://admin.fedoraproject.org/accounts/group/view/cla_done[here])
* Basic knowledge of *AsciiDoc* markup language (see xref:asciidoc-fedora:markup.adoc[AsciiDoc for Fedora])
* Basic knowledge of *AsciiDoc* markup language (see xref:contributing-docs/asciidoc-markup.adoc[AsciiDoc for Fedora])
== The Tools

View file

@ -3,11 +3,11 @@ include::ROOT:partial$attributes.adoc[]
= Contributing to Release Notes
This section describes how to contribute to Fedora Release Notes.
Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:prerequisites.adoc[Prerequisites].
Before you start following this procedure, make sure that you fulfill all the requirements listed in xref:contributing-docs/prerequisites.adoc[Prerequisites].
[TIP]
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 xref:contributing-to-existing-docs.adoc[appropriate page].
If you are interested in contributing to any other docs, see the 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.
@ -46,6 +46,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:git.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].

View file

@ -4,7 +4,7 @@ This section describes how to contribute to existing documentation - that is, do
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-to-release-notes.adoc[appropriate page].
If you are interested in contributing to Release Notes, see the xref:contributing-docs/special-contributing-to-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 +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:use-local-work-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.

View file

@ -46,7 +46,7 @@ This is to make sure we can publish your work and you do not waste your time.
. Start adding the actual ASCIIDoc content.
While writing, make sure your new source files are included in the [filename]`nav.adoc` configuration file of the module you are using
([filename]`./modules/ROOT/` by default, the location will change based on what you configured in [filename]`antora.yml` earlier).
Also make sure to use xref:local-preview.adoc[local preview] often to check your markup.
Also make sure to use xref:contributing-docs/tools-localenv-preview.adoc[local preview] often to check your markup.
. Once you finish, commit your changes and push them to your fork.

View file

@ -8,5 +8,5 @@ TBD
For larger updates or to contribute all-new documentation, you may also need:
* A plaintext editor such as [application]`vim`, [application]`emacs`, [application]`Atom`, [application]`VSCode`, etc., preferably with AsciiDoc syntax highlighting.
* [application]`git` (see xref::use-local-work-git.adoc[Git for docs writers])
* [application]`Podman` if you use a Linux OS such as Fedora or [application]`Docker CE` if you use macOS.
* [application]`git` (see xref:contributing-docs/tools-localenv-git-guide.adoc[Git for docs writers])
* [application]`Podman` if you use a Linux OS such as Fedora or [application]`Docker CE` if you use macOS.

View file

@ -14,7 +14,7 @@ To run the scripts you'll need to install [application]`Podman` if using a Linux
== Previewing multiple repositories
If your work spans content in multiple repositories,
e.g. because you xref:asciidoc-fedora: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:
----

View file

@ -24,7 +24,7 @@ The documentation team is a _peer group_ with many members involved in very diff
And by the way, _no special skills_ are necessary to be able to contribute. There are many ways and options to constructively doing so. Some are amazingly easy to use successfully without much effort - __just 7 steps away__.
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

View file

@ -67,7 +67,7 @@ If fewer than three votes are cast after one week, a single additional vote is s
=== Meetings
The team xref:meetings.adoc[meets regularly] to discuss and coordinate ongoing work.
The team xref:./meetings.adoc[meets regularly] to discuss and coordinate ongoing work.
Meeting chairs are selected on a volunteer basis.
Meetings are primarily for discussion.