docs/release-notes
19
0
Fork 7
Code Issues 41 Pull requests Projects Activity Actions

Shorten README (#402)

Browse source 
I've shortened this README based on what we came up with in this issue: docs/tickets#36

Reviewed-on: #402
Reviewed-by: Petr Bokoč <pbokoc@noreply.forge.fedoraproject.org>
This commit is contained in:
Jonas Hubeny 2026-06-04 11:38:21 +00:00 • committed by Petr Bokoč
commit 63cbfe6ac5
1 changed files with 20 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

137
README.md
View file

@ -1,126 +1,29 @@
# Fedora Release Notes
# Fedora Release Notes Documentation
Please report Issues and submit Pull Requests for **Content Fixes** here.
Don't know how this works? See our [contributor documentation](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/contrib-release-notes/).
Release Notes document the most important changes and new features in each Fedora Linux release.
## Published documentation
General appearance issues and publishing issues should be reported against
the [publishing software](https://forge.fedoraproject.org/docs/docs-fp-o).
The published version of this documentation is available at:
[https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/](https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/)
## Structure
## Contributing
```
|-- README.md
|-- antora.yml ....................... 1.
|-- build.sh ......................... 2.
|-- preview.sh ....................... 3.
|-- site.yml ......................... 4.
`-- modules
`-- ROOT ......................... 5.
|-- assets
| `-- images ............... 6.
| `-- pizza.png
|-- nav.adoc ................. 7.
`-- pages .................... 8.
|-- architecture.adoc
|-- community.adoc
|-- faq.adoc
|-- index.adoc
|-- pizza-dough.adoc
`-- pizza-oven.adoc
```
We welcome contributions! Whether it's fixing a typo, reporting an outdated
page, or writing new content — every little bit helps.
1. Metadata definition.
2. A script that does a local build. Uses docker.
3. A script that shows a preview of the site in a web browser by running a local web server. Uses docker.
4. A definition file for the build script.
5. A "root module of this documentation component". Please read below for an explanation.
6. **Images** to be used on any page.
7. **Menu definition.** Also defines the hierarchy of all the pages.
8. **Pages with the actual content.** They can be also organised into subdirectories if desired.
> **Note:** This is a versioned repository — there is a separate branch for each
> Fedora release. Pull requests should generally go to these release-specific branches.
> Branch `main` is only used as a template from which each new version is branched.
## Components and Modules
See the [Fedora Docs Contributor Guide](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/)
for how to get started.
Antora introduces two new terms:
Please report **content issues** in this repository.
For general site/publishing issues, use the
[Fedora Docs Website repository](https://forge.fedoraproject.org/docs/docs-fp-o).
* **Component** — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Poject, Fedora council, Mindshare, FESCO, but also subprojects such as CommOps or Modulartity.
* **Module** — A component can be broken down into multiple modules. Modules still share a single menu on the site, but their sources can be stored in different git repositories, even owned by different groups. The default module is called "ROOT" (that's what is in this example). If you don't want to use multiple modules, only use "ROOT". But to define more modules, simply duplicate the "ROOT" directory and name it anything you want. You can store modules in one or more git repositories.
## Local preview
This repo includes scripts to build and preview the contents of this repository.
**NOTE**: Please note that if you reference pages from other repositoreis, 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://forge.fedoraproject.org/docs/docs-fp-o) for instructions.
Both scripts work on Fedora (using Podman) and macOS (using Docker).
To build and preview the site, run:
```
$ ./build.sh && ./preview.sh
```
The result will be available at http://localhost:8080
### Installing Podman on Fedora
Fedora Workstation doesn't come with Podman preinstalled by default — so you might need to install it using the following command:
```
$ 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://forge.fedoraproject.org/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, then checkout the `prod` branch:
```
$ git clone https://forge.fedoraproject.org/docs/docs-fp-o.git
$ cd docs-fp-o
$ git checkout prod
```
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://forge.fedoraproject.org/docs/docs-fp-o.git
branches:
- main
...
```
And replaced it with a pointer to my fork:
```
...
- url: https://forge.fedoraproject.org/pbokoc/docs-fp-o
branches:
- main
...
```
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
```
## Contact
- **Matrix:** [#docs:fedoraproject.org](https://matrix.to/#/#docs:fedoraproject.org)
- **Private comms:** Use our FAS emails for anything that shouldn't be public.
- **Discussion forums:** [discussion.fedoraproject.org](https://discussion.fedoraproject.org/tag/docs-team/337)