https://github.com/fedora-minimal/documentation-minimal
Fedora Minimal documentation, for both spin and SIG.
https://github.com/fedora-minimal/documentation-minimal
fedora
Last synced: 3 months ago
JSON representation
Fedora Minimal documentation, for both spin and SIG.
- Host: GitHub
- URL: https://github.com/fedora-minimal/documentation-minimal
- Owner: fedora-minimal
- Created: 2025-02-21T22:21:30.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-21T22:34:35.000Z (3 months ago)
- Last Synced: 2025-02-21T23:42:07.505Z (3 months ago)
- Topics: fedora
- Language: Shell
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fedora Minimal Documentation
This is the build repository for the Fedora Minimal Documentation Websites. The published versions of these sites can be found at [Fedora Minimal Docs](https://docs.fedoraproject.org/en-US/minimal/) and [Fedora Minimal SIG Docs](https://docs.fedoraproject.org/en-US/minimal-sig/). Please report issues any issues with the Fedora Minimal documentation, or submit pull requests in this repository.
The latest development versions of these sites (generated from the `main` branch) can be found at [Fedora Minimal Docs](https://fedora-minimal.github.io/documentation-minimal/minimal) and [Fedora Minimal SIG Docs](https://fedora-minimal.github.io/documentation-minimal/minimal-sig).
## Contents
### `minimal-docs`
The `minimal-docs` directory contains the documentation for users and developers of the Fedora Minimal spin.
### `minimal-sig-docs`
The `minimal-sig-docs` directory contains the documentation about the Fedora Minimal SIG.
## Build and Preview
The Fedora Minimal documentation is built using [Antora](https://antora.org). General details for getting started can be found on the main Fedora Project [documentation guide](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/).
### Viewing locally
Building and previewing is done in containers and should work on any machine that has `podman` or `docker` available.
```console
$ ./docsbuilder.sh
```
Will compile and start a webserver that serves content at `https://localhost:8000`. It will automatically watch for any changes and recompile the website for you. `docsbuilder.sh` takes a `-h` argument to see more options.