Fix build errors and warnings

This commit fixes all current errors and warnings shown by antora during
documentation build.

Signed-off-by: Michal Konecny <mkonecny@redhat.com>
This commit is contained in:
Michal Konecny 2023-09-05 16:08:43 +02:00
parent 0384c92973
commit 56ebedb987
5 changed files with 24 additions and 24 deletions

View file

@ -138,12 +138,12 @@ wouldn't be possible. This would render test pipelines unusable.
|https://github.com/containerbuildsystem/osbs-client[OSBS] |https://github.com/containerbuildsystem/osbs-client[OSBS]
|OSBS (OpenShift Build System) is used to build container images for Fedora. |OSBS (OpenShift Build System) is used to build container images for Fedora.
|Without OSBS Fedora containers couldn't be built. |Without OSBS Fedora containers couldn't be built.
|`osbs-control01.iad2.fedoraproject.org` `osbs-node0{1-2}.iad2.fedoraproject.org` `osbs-master01.iad2.fedoraproject.org` `osbs-aarch64-master01.iad2.fedoraproject.org` `osbs-aarch64-node0{1-2}.iad2.fedoraproject.org` |`osbs-control01.iad2.fedoraproject.org` `osbs-node0\{1-2}.iad2.fedoraproject.org` `osbs-master01.iad2.fedoraproject.org` `osbs-aarch64-master01.iad2.fedoraproject.org` `osbs-aarch64-node0\{1-2}.iad2.fedoraproject.org`
|https://pagure.io/koji/[Koji builders] |https://pagure.io/koji/[Koji builders]
|Koji builders are machines of various architectures used by Koji to build the artifacts. |Koji builders are machines of various architectures used by Koji to build the artifacts.
|Without koji builders no artifact could be built. |Without koji builders no artifact could be built.
|`buildvm-{x86,a64,ppc64le,a32}-{01-XX}.iad2.fedoraproject.org` `buildvm-s390x-{01-XX}.s390.fedoraproject.org` |`buildvm-{x86,a64,ppc64le,a32}-\{01-XX}.iad2.fedoraproject.org` `buildvm-s390x-\{01-XX}.s390.fedoraproject.org`
|https://pagure.io/greenwave[greenwave] |https://pagure.io/greenwave[greenwave]
|Greenwave is a component that decides whether the package can pass gating or not. |Greenwave is a component that decides whether the package can pass gating or not.
@ -153,7 +153,7 @@ wouldn't be possible. This would render test pipelines unusable.
|https://pagure.io/koji/[Koji] |https://pagure.io/koji/[Koji]
|Koji is a build system handling artifact building. |Koji is a build system handling artifact building.
|Without Koji we wouldn't be able to build any artifact. |Without Koji we wouldn't be able to build any artifact.
|`koji0{1-2}.iad2.fedoraproject.org` |`koji0\{1-2}.iad2.fedoraproject.org`
|https://github.com/fedora-infra/bodhi[Bodhi] |https://github.com/fedora-infra/bodhi[Bodhi]
|Bodhi is a system that manages package updates for Fedora distribution. |Bodhi is a system that manages package updates for Fedora distribution.
@ -168,7 +168,7 @@ wouldn't be possible. This would render test pipelines unusable.
|https://pagure.io/releng/tag2distrepo[tag2distrepo] |https://pagure.io/releng/tag2distrepo[tag2distrepo]
|Koji plugin that automatically generates dist repositories on tag operations. |Koji plugin that automatically generates dist repositories on tag operations.
|Without tag2distrepo packagers wouldn't be able to create repositories on specific tag. |Without tag2distrepo packagers wouldn't be able to create repositories on specific tag.
|`koji0{1-2}.iad2.fedoraproject.org` |`koji0\{1-2}.iad2.fedoraproject.org`
|https://pagure.io/sigul[sigul] |https://pagure.io/sigul[sigul]
|Component that does signing of the artifacts. Called by robosignatory. |Component that does signing of the artifacts. Called by robosignatory.
@ -202,7 +202,7 @@ https://src.fedoraproject.org/[dist-git].
|RabbitMQ is a message broker used by fedora messaging. It assures that the message |RabbitMQ is a message broker used by fedora messaging. It assures that the message
is delivered from publisher to consumer. is delivered from publisher to consumer.
|Without it the messages will not be delivered and most of the infra will stop working. |Without it the messages will not be delivered and most of the infra will stop working.
|`rabbitmq0{1-3}.iad2.fedoraproject.org` |`rabbitmq0\{1-3}.iad2.fedoraproject.org`
|https://github.com/fedora-infra/fedora-messaging[fedora messaging] |https://github.com/fedora-infra/fedora-messaging[fedora messaging]
|Python library for working with fedora messaging system. It helps you create fedora |Python library for working with fedora messaging system. It helps you create fedora
@ -231,7 +231,7 @@ with fedora messages and affect whole Fedora infrastructure.
|Mediawiki is used by Fedora as their choice of Wikipedia-like web server. It's powering |Mediawiki is used by Fedora as their choice of Wikipedia-like web server. It's powering
https://fedoraproject.org/wiki[Fedora wiki pages]. https://fedoraproject.org/wiki[Fedora wiki pages].
|Without wiki Fedora wiki pages wouldn't run. |Without wiki Fedora wiki pages wouldn't run.
|`wiki0{1-2}.iad2.fedoraproject.org` |`wiki0\{1-2}.iad2.fedoraproject.org`
|https://github.com/fedora-infra/fmn[FMN] |https://github.com/fedora-infra/fmn[FMN]
|FMN (FedMSG Notifications) is an application listening for messages in Fedora infra and based on the |FMN (FedMSG Notifications) is an application listening for messages in Fedora infra and based on the

View file

@ -6,7 +6,7 @@ The following SOPs are related to the administration of the fas2discourse operat
- https://quay.io/repository/fedora/fas2discourse-operator[Image] - https://quay.io/repository/fedora/fas2discourse-operator[Image]
- https://pagure.io/fedora-infrastructure/issue/10952[Initial ticket] - https://pagure.io/fedora-infrastructure/issue/10952[Initial ticket]
- xref:sop_fas2discourse_operator_installation.adoc[Install the fas2discourse operator] - xref:sop_fas2discourse_operator_installation.adoc[Install the fas2discourse operator]
- xref:sop_fas2idscourse_operator_testing.adoc[Testing the fas2discourse operator] - xref:sop_fas2discourse_operator_testing.adoc[Testing the fas2discourse operator]
- xref:sop_fas2discourse_operator_build.adoc[Building/releasing the fas2discourse operator] - xref:sop_fas2discourse_operator_build.adoc[Building/releasing the fas2discourse operator]
- xref:sop_fas2discourse_operator_interacting.adoc[Interacting with the the fas2discourse operator] - xref:sop_fas2discourse_operator_interacting.adoc[Interacting with the the fas2discourse operator]
- xref:sop_fas2discourse_operator_debugging.adoc[Debugging issues with the the fas2discourse operator] - xref:sop_fas2discourse_operator_debugging.adoc[Debugging issues with the the fas2discourse operator]

View file

@ -13,7 +13,7 @@ You will find below the list of steps to follow to branch a new Fedora release.
== Mass resigning == Mass resigning
When we branch off of rawhide, the branched release packages are already signed by When we branch off of rawhide, the branched release packages are already signed by
the F{release} key, but we need to resign everything in rawhide for the new F+1 key. the F\{release} key, but we need to resign everything in rawhide for the new F+1 key.
ie, When we branch f39 off rawhide, all it's packages are already signed by the f39 ie, When we branch f39 off rawhide, all it's packages are already signed by the f39
key, but we need to resign everything with the f40 key for rawhide. key, but we need to resign everything with the f40 key for rawhide.
@ -254,7 +254,7 @@ Changes to `fedora-release.spec` in the *rawhide* branch:
[source,subs="attributes"] [source,subs="attributes"]
---- ----
Version: {rawhide} Version: {rawhide}
Release: 0.1%{?eln:.eln%{eln}} Release: 0.1%{?eln:.eln%\{eln}}
---- ----
. Add a `%changelog` entry: . Add a `%changelog` entry:
@ -291,7 +291,7 @@ Version: {branched}
+ +
[source,subs="attributes"] [source,subs="attributes"]
---- ----
Release: 0.4%{?eln:.eln%{eln}} Release: 0.4%{?eln:.eln%\{eln}}
---- ----
. Add a `%changelog` entry: . Add a `%changelog` entry:
@ -341,7 +341,7 @@ fedora-{rawhide+1}-primary: x86_64 armhfp aarch64 ppc64le s390x
[source,subs="attributes"] [source,subs="attributes"]
---- ----
Version: {rawhide} Version: {rawhide}
Release: 0.1%{?eln:.eln%{eln}} Release: 0.1%{?eln:.eln%\{eln}}
---- ----
. Add a `%changelog` entry: . Add a `%changelog` entry:
@ -385,7 +385,7 @@ Source57: RPM-GPG-KEY-fedora-{rawhide_next}-primary
+ +
[source,subs="attributes"] [source,subs="attributes"]
---- ----
Release: 0.3%{?eln:.eln%{eln}} + Release: 0.3%{?eln:.eln%\{eln}} +
---- ----
. Add a `%changelog` entry: . Add a `%changelog` entry:
+ +
@ -426,7 +426,7 @@ Source57: RPM-GPG-KEY-fedora-{rawhide_next}-primary
+ +
[source,subs="attributes"] [source,subs="attributes"]
---- ----
Release: 0.3%{?eln:.eln%{eln}} Release: 0.3%{?eln:.eln%\{eln}}
---- ----
. Add a `%changelog` entry: . Add a `%changelog` entry:
@ -621,7 +621,7 @@ $ BASEIMAGE_URL="https://kojipkgs.fedoraproject.org//packages/Fedora-Docker-Base
$ RAWHIDE="27" $ RAWHIDE="27"
# Load the latest, find it's image name # Load the latest, find it's image name
$ sudo docker load < <(curl -s "${BASEIMAGE_URL}") $ sudo docker load < <(curl -s "$\{BASEIMAGE_URL}")
$ sudo docker images | grep base-rawhide $ sudo docker images | grep base-rawhide
fedora-docker-base-rawhide-20170310.n.0.x86_64 latest ffd832a990ca 5 hours ago 201.8 MB fedora-docker-base-rawhide-20170310.n.0.x86_64 latest ffd832a990ca 5 hours ago 201.8 MB

View file

@ -165,7 +165,7 @@ or not we release and they may pull the plug at any moment.
Once given the ok to release, the Infrastructure team should publish the Once given the ok to release, the Infrastructure team should publish the
torrent and encourage people to seed. Complete the steps on the torrent and encourage people to seed. Complete the steps on the
<<torrentrelease.adoc#>> after step 4. <<infra:release_guide:torrentrelease.adoc#>> after step 4.
=== Step 3 (Bit flip) === Step 3 (Bit flip)

View file

@ -44,21 +44,21 @@ run: 'ssh-keygen -t ed25519'
Make sure you enter a strong passphrase you can remember or have stored in a password manager. Make sure you enter a strong passphrase you can remember or have stored in a password manager.
2. Setup your local client ssh config 2. Setup your local client ssh config
+
.... ....
vi ~/.ssh/config vi ~/.ssh/config
.... ....
+
(Or use any text editor you are comfortable with) (Or use any text editor you are comfortable with)
+
[NOTE] [NOTE]
==== ====
This file, and any keys, need to be mode 600, or you will get a "Bad This file, and any keys, need to be mode 600, or you will get a "Bad
owner or permissions" error. The .ssh directory must be mode 700. owner or permissions" error. The .ssh directory must be mode 700.
==== ====
+
then, add the following contents to that text file: then, add the following contents to that text file:
+
.... ....
Host bastion.fedoraproject.org Host bastion.fedoraproject.org
HostName bastion.fedoraproject.org HostName bastion.fedoraproject.org
@ -70,7 +70,7 @@ Host *.iad2.fedoraproject.org *.qa.fedoraproject.org 10.3.160.* 10.3.161.* 10.3.
Host batcave01 Host batcave01
HostName %h.iad2.fedoraproject.org HostName %h.iad2.fedoraproject.org
.... ....
+
Note that there are 2 bastion servers: bastion01.fedoraproject.org Note that there are 2 bastion servers: bastion01.fedoraproject.org
and bastion02.fedoraproject.org. The 'bastion.fedoraproject.org' name and bastion02.fedoraproject.org. The 'bastion.fedoraproject.org' name
should match whichever one is primary at any time. If for some reason should match whichever one is primary at any time. If for some reason
@ -79,11 +79,11 @@ change the above to specifically point to bastion01 or bastion02.
Normally this should not be needed. Normally this should not be needed.
3. Setup the fedora infrastructure ssh hostkey certificate authority: 3. Setup the fedora infrastructure ssh hostkey certificate authority:
+
download https://admin.fedoraproject.org/ssh_known_hosts Download https://admin.fedoraproject.org/ssh_known_hosts
and add it to (or create if it does not yet exist) a and add it to (or create if it does not yet exist) a
~/.ssh/known_hosts file. ~/.ssh/known_hosts file.
+
This tells OpenSSH to trust any host keys that are signed with This tells OpenSSH to trust any host keys that are signed with
the fedora infrastructure ssh certificate authority. This allows the fedora infrastructure ssh certificate authority. This allows
you to know when you login to a machine that it's not been you to know when you login to a machine that it's not been