2025-09-08 16:18:58 +10:00
# Fedora Forge Documentation
Initial Import from Fedora Docs Template
https://gitlab.com/fedora/docs/templates/fedora-docs-template
Initial Commit
switch to Antora
Preview of the whole site
preview.sh: Allow preview.sh keep running for multiple build.sh calls
antora deletes and recreates public/ every time the docs are rebuilt;
mounting public/ directly meant that when build.sh, the existing nginx
container didn't see the new docs. Instead of mounting public/ directly
into the nginx default webroot, mount the parent directory at /antora,
and install a tiny nginx configuration file to point the webroot at the
right place.
fix preview.sh for macOS
Issue 3 - Check if sudo is really required to run docker
Provide better messages on the command line
deduplicate and in build.sh
Use podman as an option for local build/preview docs
The podman binary is an alternative to docker that might be used
by some people in preference. In this use case it's a drop in
replacement, we can just check for it, else we just use docker
as before.
Signed-off-by: Peter Robinson <pbrobinson@gmail.com>
using podman on Fedora — root not required anymore
Add workaround for --directory flag breaking in preview.sh script
Closes #13.
authors example
Add LICENSE
It's oven not owen
Replace test == operator with =
The == operator of test (invoked as [) is a Bash extension.
Use the = operator of [POSIX test] for string equality.
[POSIX test]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Quote command substitution which may have spaces
If $(pwd) or $(uname -s) contain spaces, their output will undergo word
splitting and be passed as multiple arguments, which would cause the
programs receiving them to misbehave. Avoid this by quoting.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Fix misspellings
build.sh: fix misspelling and replace tab with spaces
Some lines had tabs, others had spaces. Uniformizing for spaces.
Add proper partials and examples directories with usage notes
Fix typo in README
Update build script for Aarch64 and local antora installs
Fix if conditions in build.sh
Earlier comment removed quotation from around command substitions $().
This is not a good idea,
because if the substitution produces whitespace,
without the quotes, the result is not interpreted as a single string.
Pattern 'if [ $(uname) == "foo" ]'
is replaced with 'uname | grep -iwq foo' here.
Apart from following good shell scripting practices,
this commit fixes the problem where the script failed
if the current working directory's patch contained whitespace.
Fix the Linux docker branch of build.sh
There were multiple problems in the Linux docker branch of build.sh:
- Intendation was wrong
- There was a reference to undefined variable $runtime,
leading to corrupted output.
- Output had strange linebreaks.
Fix intendation in build.sh error branch
Use `version: ~` in antora.yml
Antora 3 has deprecated `version: master`.
Replacing it with a current alternative.
Update configuration for Antora 3.0
Whitespace and formating cleanup
build.sh: Properly quote all variables
Fix overquoting for ${cmd}
Fixes:
```
$ ./build.sh
This build script is using Podman to run the build in an isolated environment.
antora: option '--html-url-extension-style <choice>' argument 'indexify site.yml' is invalid. Allowed choices are default, drop, indexify.
```
update antora playbook
add preview pages
remove indexify extension from args
build.sh: Fix overquoting again
Missed in 7d3a02b
add content related issue template
update antora config & CI workflow
Update and correct licensing information
site.yaml: Use indexify mode for URLs
Official Fedora docs use that extension thus keep using it for local
preview.
Fixes: https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/4
This reworks commit bca134e1c05d93db7acecacdfefc4afabd8a1223.
Improve .gitignore
The intent of existing .gitignore was to ignore some directories
at repository root.
Instead, it was ignoring any file or directory by given names,
anywhere in the tree.
Improve rules to only match the intended cases.
feat: add new builder script
feat(docsbuilder.sh): add MIT license
Fixes https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/5
docsbuilder: chmod a+x
Update README.md with docsbuilder command
Adding podman to the description.
docsbuilder: Use command to find binaries in PATH
Do not assume that commands are installed in a specific PATH and use
`command` instead to find them. This makes running this inside toolbox
works.
README: Re-add nginx.conf and update for osbuilder script
Use custom Antora image
2017-08-31 09:52:18 -04:00
2025-09-15 18:13:21 +10:00
The official Fedora Forge documentation is available at: https://docs.fedoraproject.org/en-US/forge-documentation/
This repository contains the source documentation for Fedora Forge, the official collaboration platform for Fedora teams, SIGs, and subprojects. The documentation covers:
2025-10-20 08:05:08 +00:00
- **User Documentation**: Guides for creating organization front pages, requesting new organizations and teams, and using HTTPS authentication.
- **Admin Documentation**: Procedures for creating new organizations and teams.
- **Migration Guides**: Step-by-step instructions for migrating projects from Pagure.io to Fedora Forge, including restoring issue dependencies and assignments.
- **Known Issues**: Workarounds for common problems encountered on Fedora Forge.
2025-09-15 18:13:21 +10:00
Initial Import from Fedora Docs Template
https://gitlab.com/fedora/docs/templates/fedora-docs-template
Initial Commit
switch to Antora
Preview of the whole site
preview.sh: Allow preview.sh keep running for multiple build.sh calls
antora deletes and recreates public/ every time the docs are rebuilt;
mounting public/ directly meant that when build.sh, the existing nginx
container didn't see the new docs. Instead of mounting public/ directly
into the nginx default webroot, mount the parent directory at /antora,
and install a tiny nginx configuration file to point the webroot at the
right place.
fix preview.sh for macOS
Issue 3 - Check if sudo is really required to run docker
Provide better messages on the command line
deduplicate and in build.sh
Use podman as an option for local build/preview docs
The podman binary is an alternative to docker that might be used
by some people in preference. In this use case it's a drop in
replacement, we can just check for it, else we just use docker
as before.
Signed-off-by: Peter Robinson <pbrobinson@gmail.com>
using podman on Fedora — root not required anymore
Add workaround for --directory flag breaking in preview.sh script
Closes #13.
authors example
Add LICENSE
It's oven not owen
Replace test == operator with =
The == operator of test (invoked as [) is a Bash extension.
Use the = operator of [POSIX test] for string equality.
[POSIX test]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Quote command substitution which may have spaces
If $(pwd) or $(uname -s) contain spaces, their output will undergo word
splitting and be passed as multiple arguments, which would cause the
programs receiving them to misbehave. Avoid this by quoting.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Fix misspellings
build.sh: fix misspelling and replace tab with spaces
Some lines had tabs, others had spaces. Uniformizing for spaces.
Add proper partials and examples directories with usage notes
Fix typo in README
Update build script for Aarch64 and local antora installs
Fix if conditions in build.sh
Earlier comment removed quotation from around command substitions $().
This is not a good idea,
because if the substitution produces whitespace,
without the quotes, the result is not interpreted as a single string.
Pattern 'if [ $(uname) == "foo" ]'
is replaced with 'uname | grep -iwq foo' here.
Apart from following good shell scripting practices,
this commit fixes the problem where the script failed
if the current working directory's patch contained whitespace.
Fix the Linux docker branch of build.sh
There were multiple problems in the Linux docker branch of build.sh:
- Intendation was wrong
- There was a reference to undefined variable $runtime,
leading to corrupted output.
- Output had strange linebreaks.
Fix intendation in build.sh error branch
Use `version: ~` in antora.yml
Antora 3 has deprecated `version: master`.
Replacing it with a current alternative.
Update configuration for Antora 3.0
Whitespace and formating cleanup
build.sh: Properly quote all variables
Fix overquoting for ${cmd}
Fixes:
```
$ ./build.sh
This build script is using Podman to run the build in an isolated environment.
antora: option '--html-url-extension-style <choice>' argument 'indexify site.yml' is invalid. Allowed choices are default, drop, indexify.
```
update antora playbook
add preview pages
remove indexify extension from args
build.sh: Fix overquoting again
Missed in 7d3a02b
add content related issue template
update antora config & CI workflow
Update and correct licensing information
site.yaml: Use indexify mode for URLs
Official Fedora docs use that extension thus keep using it for local
preview.
Fixes: https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/4
This reworks commit bca134e1c05d93db7acecacdfefc4afabd8a1223.
Improve .gitignore
The intent of existing .gitignore was to ignore some directories
at repository root.
Instead, it was ignoring any file or directory by given names,
anywhere in the tree.
Improve rules to only match the intended cases.
feat: add new builder script
feat(docsbuilder.sh): add MIT license
Fixes https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/5
docsbuilder: chmod a+x
Update README.md with docsbuilder command
Adding podman to the description.
docsbuilder: Use command to find binaries in PATH
Do not assume that commands are installed in a specific PATH and use
`command` instead to find them. This makes running this inside toolbox
works.
README: Re-add nginx.conf and update for osbuilder script
Use custom Antora image
2017-08-31 09:52:18 -04:00
## Local preview
2025-09-15 18:13:21 +10:00
This repository includes a script to build and preview the Fedora Forge documentation locally.
Initial Import from Fedora Docs Template
https://gitlab.com/fedora/docs/templates/fedora-docs-template
Initial Commit
switch to Antora
Preview of the whole site
preview.sh: Allow preview.sh keep running for multiple build.sh calls
antora deletes and recreates public/ every time the docs are rebuilt;
mounting public/ directly meant that when build.sh, the existing nginx
container didn't see the new docs. Instead of mounting public/ directly
into the nginx default webroot, mount the parent directory at /antora,
and install a tiny nginx configuration file to point the webroot at the
right place.
fix preview.sh for macOS
Issue 3 - Check if sudo is really required to run docker
Provide better messages on the command line
deduplicate and in build.sh
Use podman as an option for local build/preview docs
The podman binary is an alternative to docker that might be used
by some people in preference. In this use case it's a drop in
replacement, we can just check for it, else we just use docker
as before.
Signed-off-by: Peter Robinson <pbrobinson@gmail.com>
using podman on Fedora — root not required anymore
Add workaround for --directory flag breaking in preview.sh script
Closes #13.
authors example
Add LICENSE
It's oven not owen
Replace test == operator with =
The == operator of test (invoked as [) is a Bash extension.
Use the = operator of [POSIX test] for string equality.
[POSIX test]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Quote command substitution which may have spaces
If $(pwd) or $(uname -s) contain spaces, their output will undergo word
splitting and be passed as multiple arguments, which would cause the
programs receiving them to misbehave. Avoid this by quoting.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Fix misspellings
build.sh: fix misspelling and replace tab with spaces
Some lines had tabs, others had spaces. Uniformizing for spaces.
Add proper partials and examples directories with usage notes
Fix typo in README
Update build script for Aarch64 and local antora installs
Fix if conditions in build.sh
Earlier comment removed quotation from around command substitions $().
This is not a good idea,
because if the substitution produces whitespace,
without the quotes, the result is not interpreted as a single string.
Pattern 'if [ $(uname) == "foo" ]'
is replaced with 'uname | grep -iwq foo' here.
Apart from following good shell scripting practices,
this commit fixes the problem where the script failed
if the current working directory's patch contained whitespace.
Fix the Linux docker branch of build.sh
There were multiple problems in the Linux docker branch of build.sh:
- Intendation was wrong
- There was a reference to undefined variable $runtime,
leading to corrupted output.
- Output had strange linebreaks.
Fix intendation in build.sh error branch
Use `version: ~` in antora.yml
Antora 3 has deprecated `version: master`.
Replacing it with a current alternative.
Update configuration for Antora 3.0
Whitespace and formating cleanup
build.sh: Properly quote all variables
Fix overquoting for ${cmd}
Fixes:
```
$ ./build.sh
This build script is using Podman to run the build in an isolated environment.
antora: option '--html-url-extension-style <choice>' argument 'indexify site.yml' is invalid. Allowed choices are default, drop, indexify.
```
update antora playbook
add preview pages
remove indexify extension from args
build.sh: Fix overquoting again
Missed in 7d3a02b
add content related issue template
update antora config & CI workflow
Update and correct licensing information
site.yaml: Use indexify mode for URLs
Official Fedora docs use that extension thus keep using it for local
preview.
Fixes: https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/4
This reworks commit bca134e1c05d93db7acecacdfefc4afabd8a1223.
Improve .gitignore
The intent of existing .gitignore was to ignore some directories
at repository root.
Instead, it was ignoring any file or directory by given names,
anywhere in the tree.
Improve rules to only match the intended cases.
feat: add new builder script
feat(docsbuilder.sh): add MIT license
Fixes https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/5
docsbuilder: chmod a+x
Update README.md with docsbuilder command
Adding podman to the description.
docsbuilder: Use command to find binaries in PATH
Do not assume that commands are installed in a specific PATH and use
`command` instead to find them. This makes running this inside toolbox
works.
README: Re-add nginx.conf and update for osbuilder script
Use custom Antora image
2017-08-31 09:52:18 -04:00
2025-09-15 18:13:21 +10:00
**NOTE**: Please note that if you reference pages from other Fedora documentation repositories, such links will be broken in this local preview as it only builds the Fedora Forge documentation repository.
Initial Import from Fedora Docs Template
https://gitlab.com/fedora/docs/templates/fedora-docs-template
Initial Commit
switch to Antora
Preview of the whole site
preview.sh: Allow preview.sh keep running for multiple build.sh calls
antora deletes and recreates public/ every time the docs are rebuilt;
mounting public/ directly meant that when build.sh, the existing nginx
container didn't see the new docs. Instead of mounting public/ directly
into the nginx default webroot, mount the parent directory at /antora,
and install a tiny nginx configuration file to point the webroot at the
right place.
fix preview.sh for macOS
Issue 3 - Check if sudo is really required to run docker
Provide better messages on the command line
deduplicate and in build.sh
Use podman as an option for local build/preview docs
The podman binary is an alternative to docker that might be used
by some people in preference. In this use case it's a drop in
replacement, we can just check for it, else we just use docker
as before.
Signed-off-by: Peter Robinson <pbrobinson@gmail.com>
using podman on Fedora — root not required anymore
Add workaround for --directory flag breaking in preview.sh script
Closes #13.
authors example
Add LICENSE
It's oven not owen
Replace test == operator with =
The == operator of test (invoked as [) is a Bash extension.
Use the = operator of [POSIX test] for string equality.
[POSIX test]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Quote command substitution which may have spaces
If $(pwd) or $(uname -s) contain spaces, their output will undergo word
splitting and be passed as multiple arguments, which would cause the
programs receiving them to misbehave. Avoid this by quoting.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Fix misspellings
build.sh: fix misspelling and replace tab with spaces
Some lines had tabs, others had spaces. Uniformizing for spaces.
Add proper partials and examples directories with usage notes
Fix typo in README
Update build script for Aarch64 and local antora installs
Fix if conditions in build.sh
Earlier comment removed quotation from around command substitions $().
This is not a good idea,
because if the substitution produces whitespace,
without the quotes, the result is not interpreted as a single string.
Pattern 'if [ $(uname) == "foo" ]'
is replaced with 'uname | grep -iwq foo' here.
Apart from following good shell scripting practices,
this commit fixes the problem where the script failed
if the current working directory's patch contained whitespace.
Fix the Linux docker branch of build.sh
There were multiple problems in the Linux docker branch of build.sh:
- Intendation was wrong
- There was a reference to undefined variable $runtime,
leading to corrupted output.
- Output had strange linebreaks.
Fix intendation in build.sh error branch
Use `version: ~` in antora.yml
Antora 3 has deprecated `version: master`.
Replacing it with a current alternative.
Update configuration for Antora 3.0
Whitespace and formating cleanup
build.sh: Properly quote all variables
Fix overquoting for ${cmd}
Fixes:
```
$ ./build.sh
This build script is using Podman to run the build in an isolated environment.
antora: option '--html-url-extension-style <choice>' argument 'indexify site.yml' is invalid. Allowed choices are default, drop, indexify.
```
update antora playbook
add preview pages
remove indexify extension from args
build.sh: Fix overquoting again
Missed in 7d3a02b
add content related issue template
update antora config & CI workflow
Update and correct licensing information
site.yaml: Use indexify mode for URLs
Official Fedora docs use that extension thus keep using it for local
preview.
Fixes: https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/4
This reworks commit bca134e1c05d93db7acecacdfefc4afabd8a1223.
Improve .gitignore
The intent of existing .gitignore was to ignore some directories
at repository root.
Instead, it was ignoring any file or directory by given names,
anywhere in the tree.
Improve rules to only match the intended cases.
feat: add new builder script
feat(docsbuilder.sh): add MIT license
Fixes https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/5
docsbuilder: chmod a+x
Update README.md with docsbuilder command
Adding podman to the description.
docsbuilder: Use command to find binaries in PATH
Do not assume that commands are installed in a specific PATH and use
`command` instead to find them. This makes running this inside toolbox
works.
README: Re-add nginx.conf and update for osbuilder script
Use custom Antora image
2017-08-31 09:52:18 -04:00
2025-09-15 18:13:21 +10:00
The script works on Fedora (using Podman or Docker).
Initial Import from Fedora Docs Template
https://gitlab.com/fedora/docs/templates/fedora-docs-template
Initial Commit
switch to Antora
Preview of the whole site
preview.sh: Allow preview.sh keep running for multiple build.sh calls
antora deletes and recreates public/ every time the docs are rebuilt;
mounting public/ directly meant that when build.sh, the existing nginx
container didn't see the new docs. Instead of mounting public/ directly
into the nginx default webroot, mount the parent directory at /antora,
and install a tiny nginx configuration file to point the webroot at the
right place.
fix preview.sh for macOS
Issue 3 - Check if sudo is really required to run docker
Provide better messages on the command line
deduplicate and in build.sh
Use podman as an option for local build/preview docs
The podman binary is an alternative to docker that might be used
by some people in preference. In this use case it's a drop in
replacement, we can just check for it, else we just use docker
as before.
Signed-off-by: Peter Robinson <pbrobinson@gmail.com>
using podman on Fedora — root not required anymore
Add workaround for --directory flag breaking in preview.sh script
Closes #13.
authors example
Add LICENSE
It's oven not owen
Replace test == operator with =
The == operator of test (invoked as [) is a Bash extension.
Use the = operator of [POSIX test] for string equality.
[POSIX test]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Quote command substitution which may have spaces
If $(pwd) or $(uname -s) contain spaces, their output will undergo word
splitting and be passed as multiple arguments, which would cause the
programs receiving them to misbehave. Avoid this by quoting.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Fix misspellings
build.sh: fix misspelling and replace tab with spaces
Some lines had tabs, others had spaces. Uniformizing for spaces.
Add proper partials and examples directories with usage notes
Fix typo in README
Update build script for Aarch64 and local antora installs
Fix if conditions in build.sh
Earlier comment removed quotation from around command substitions $().
This is not a good idea,
because if the substitution produces whitespace,
without the quotes, the result is not interpreted as a single string.
Pattern 'if [ $(uname) == "foo" ]'
is replaced with 'uname | grep -iwq foo' here.
Apart from following good shell scripting practices,
this commit fixes the problem where the script failed
if the current working directory's patch contained whitespace.
Fix the Linux docker branch of build.sh
There were multiple problems in the Linux docker branch of build.sh:
- Intendation was wrong
- There was a reference to undefined variable $runtime,
leading to corrupted output.
- Output had strange linebreaks.
Fix intendation in build.sh error branch
Use `version: ~` in antora.yml
Antora 3 has deprecated `version: master`.
Replacing it with a current alternative.
Update configuration for Antora 3.0
Whitespace and formating cleanup
build.sh: Properly quote all variables
Fix overquoting for ${cmd}
Fixes:
```
$ ./build.sh
This build script is using Podman to run the build in an isolated environment.
antora: option '--html-url-extension-style <choice>' argument 'indexify site.yml' is invalid. Allowed choices are default, drop, indexify.
```
update antora playbook
add preview pages
remove indexify extension from args
build.sh: Fix overquoting again
Missed in 7d3a02b
add content related issue template
update antora config & CI workflow
Update and correct licensing information
site.yaml: Use indexify mode for URLs
Official Fedora docs use that extension thus keep using it for local
preview.
Fixes: https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/4
This reworks commit bca134e1c05d93db7acecacdfefc4afabd8a1223.
Improve .gitignore
The intent of existing .gitignore was to ignore some directories
at repository root.
Instead, it was ignoring any file or directory by given names,
anywhere in the tree.
Improve rules to only match the intended cases.
feat: add new builder script
feat(docsbuilder.sh): add MIT license
Fixes https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/5
docsbuilder: chmod a+x
Update README.md with docsbuilder command
Adding podman to the description.
docsbuilder: Use command to find binaries in PATH
Do not assume that commands are installed in a specific PATH and use
`command` instead to find them. This makes running this inside toolbox
works.
README: Re-add nginx.conf and update for osbuilder script
Use custom Antora image
2017-08-31 09:52:18 -04:00
To build and preview the site, run:
```
$ ./docsbuilder.sh -p
```
The result will be available at http://localhost:8080
To stop the preview:
```
$ ./docsbuilder.sh -k
```
### Installing Podman on Fedora
Fedora Workstation doesn't come with Podman preinstalled by default —
```
$ sudo dnf install podman
```
# License
SPDX-License-Identifier: CC-BY-SA-4.0
