forked from forge/documentation
Update README with documentation overview and Fedora Forge-specific wording
- Add detailed description of repository contents including user docs, admin docs, migration guides, and known issues - Update local preview section to use Fedora Forge-specific terminology instead of generic repository language - Add link to official published documentation at docs.fedoraproject.org - Remove outdated section about building whole Fedora Docs site locally
This commit is contained in:
parent
da918b86c0
commit
775d9f5489
1 changed files with 12 additions and 56 deletions
68
README.md
68
README.md
|
|
@ -1,12 +1,21 @@
|
|||
# Fedora Forge Documentation
|
||||
|
||||
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:
|
||||
|
||||
- **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
|
||||
|
||||
## Local preview
|
||||
|
||||
This repo includes a script to build and preview the contents of this repository.
|
||||
This repository includes a script to build and preview the Fedora Forge documentation locally.
|
||||
|
||||
**NOTE**: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.
|
||||
**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.
|
||||
|
||||
The script works on Fedora (using Podman or Docker) and macOS (using Docker).
|
||||
The script works on Fedora (using Podman or Docker).
|
||||
|
||||
To build and preview the site, run:
|
||||
|
||||
|
|
@ -31,59 +40,6 @@ Fedora Workstation doesn't come with Podman preinstalled by default — so you
|
|||
$ sudo dnf install podman
|
||||
```
|
||||
|
||||
### Preview as a part of the whole Fedora Docs site
|
||||
|
||||
You can also build the whole Fedora Docs site locally to see your changes in the whole context.
|
||||
This is especially useful for checking if your `xref` links work properly.
|
||||
|
||||
To do this, you need to clone the main [Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o), modify the `site.yml` file to reference a repo with your changes, and build it.
|
||||
Steps:
|
||||
|
||||
Clone the main repository and cd into it:
|
||||
|
||||
```
|
||||
$ git clone https://pagure.io/fedora-docs/docs-fp-o.git
|
||||
$ cd docs-fp-o
|
||||
```
|
||||
|
||||
Find a reference to the repository you're changing in the `site.yml` file, and change it so it points to your change.
|
||||
So for example, if I made a modification to the Modularity docs, I would find:
|
||||
|
||||
```
|
||||
...
|
||||
- url: https://pagure.io/fedora-docs/modularity.git
|
||||
branches:
|
||||
- master
|
||||
...
|
||||
```
|
||||
|
||||
And replaced it with a pointer to my fork:
|
||||
```
|
||||
...
|
||||
- url: https://pagure.io/forks/asamalik/fedora-docs/modularity.git
|
||||
branches:
|
||||
- master
|
||||
...
|
||||
```
|
||||
|
||||
I could also point to a local repository, using `HEAD` as a branch to preview the what's changed without the need of making a commit.
|
||||
|
||||
**Note:** I would need to move the repository under the `docs-fp-o` directory, because the builder won't see anything above.
|
||||
So I would need to create a `repositories` directory in `docs-fp-o` and copy my repository into it.
|
||||
|
||||
```
|
||||
...
|
||||
- url: ./repositories/modularity
|
||||
branches:
|
||||
- HEAD
|
||||
...
|
||||
```
|
||||
|
||||
To build the whole site, I would run the following in the `docs-fp-o` directory.
|
||||
|
||||
```
|
||||
$ ./docsbuilder.sh -p
|
||||
```
|
||||
# License
|
||||
|
||||
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue