| |
@@ -1,7 +1,7 @@
|
| |
# Fedora Release Notes
|
| |
|
| |
Please report Issues and submit Pull Requests for **Content Fixes** here.
|
| |
- Never done a pull request (or "PR")? Here's the [Pagure documentation for
|
| |
+ Never done a pull request (or “PR”)? Here's the [Pagure documentation for
|
| |
Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html).
|
| |
|
| |
|
| |
@@ -35,7 +35,7 @@
|
| |
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.
|
| |
+ 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.
|
| |
@@ -45,7 +45,7 @@
|
| |
Antora introduces two new terms:
|
| |
|
| |
* **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.
|
| |
+ * **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
|
| |
|
| |
Before this change, this documentation in this repo would present the
reader with U+0022 QUOTATION MARKs. According to Unicode, it’s better to
use U+201C LEFT DOUBLE QUOTATION MARK and U+201D RIGHT DOUBLE QUOTATION
MARK (Source: https://www.unicode.org/charts/PDF/U0000.pdf#page=3).