Update repo URLs to Fedora forge + fix preview.pid

Signed-off-by: Michael Winters <fedora@mwinters.net>
This commit is contained in:
Michael Winters 2026-04-08 17:54:05 -05:00
commit c9bb68a247
Signed by untrusted user: mwinters
GPG key ID: F72C1429A9440862
3 changed files with 8 additions and 9 deletions

3
.gitignore vendored
View file

@ -3,3 +3,6 @@ gl-code-quality-report.json
build
cache
public
# created when the docsbuilder local preview is running
preview.pid

View file

@ -17,12 +17,9 @@ 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://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].
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.
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.
Simply clone the https://forge.fedoraproject.org/docs/docs-template[template repository] manually and copy the content to your new repository.
.Example of a simple documentation repository structure
----
@ -63,7 +60,7 @@ While you're writing, you can use the xref:contributing-docs/tools-localenv-prev
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://gitlab.com/fedora/docs/docs-website/docs-fp-o/-/blob/prod/site.yml[main Antora playbook].
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].
To add a new documentation module, you will need to add its repository to the `content.sources` list:
@ -71,7 +68,7 @@ To add a new documentation module, you will need to add its repository to the `c
----
content:
sources:
- url: https://gitlab.com/path/to/new/repository.git
- url: https://forge.fedoraproject.org/path/to/new/repository.git
branches: main <.>
start_path: docs <.>
----
@ -79,7 +76,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 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.
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.
[NOTE]

View file

@ -1 +0,0 @@
10709