quick-docs/README.md

# Fedora Quick Docs

This is the content repository for the Fedora Quick Docs.

Please report Issues and submit Pull Requests for **Content Fixes** here.
Never done a pull request (or "PR")? Here's the [Pagure documentation for
Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html).


General appearance issues and publishing issues should be reported against
the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).

## Reviewers needed!

As discussed in [issue #107](https://pagure.io/fedora-docs/quick-docs/issue/107),
a lot of pages in this repository are in need of a technical review. Pages which need
one are marked by a disclaimer on the top of the file, right below the top level heading.
Any reviews are greatly appreciated. If you want to help, pick one of the pages, check it
for accuracy, and then:

* If you find that all information on the page is correct, either open a pull request which states that you found no problems and which removes the disclaimer from the top (the `include::`) statement at the top, or open an issue against this repository stating which page you reviewed and found no errors in so we can remove it
* If you find errors, then either open a pull request fixing them and removing the disclaimer from the top, or open an issue and describe the errors you found, and how to fix them if you know a fix

## How to edit these documents

All of this is written in AsciiDoc. It's a simple mostly-plain-text
markup language. You may want to look at:


* [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
* [AsciiDoc Writer's Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)
* [Antora Documentation](https://docs.antora.org/antora/1.0/page/)


## 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 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.

Both scripts use podman in F30 and above. Please make sure you have podman installed on your system (you can also use Docker, but on Fedora podman is recommended).

### Installing podman on Fedora
```
$ sudo dnf install podman
```

To build and preview the site, run:

```
$ ./build.sh && ./preview.sh
```

The result will be available at http://localhost:8080
initial commit 2017-10-25 21:52:14 +00:00			`# Fedora Quick Docs`

Add 'unverified' banner on top of each file and review instructions to readme 2019-03-20 22:42:41 +00:00			`This is the content repository for the Fedora Quick Docs.`
initial commit 2017-10-25 21:52:14 +00:00
switch to Antora part 2018-07-27 14:38:30 +00:00			`Please report Issues and submit Pull Requests for Content Fixes here.`
			`Never done a pull request (or "PR")? Here's the [Pagure documentation for`
			`Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html).`
initial commit 2017-10-25 21:52:14 +00:00
"Hiding" unfinished work so we can publish this 2018-03-03 21:30:37 +00:00
switch to Antora part 2018-07-27 14:38:30 +00:00			`General appearance issues and publishing issues should be reported against`
			`the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).`
initial commit 2017-10-25 21:52:14 +00:00
Fix a typo in readme 2019-04-23 10:24:11 +00:00			`## Reviewers needed!`
Add 'unverified' banner on top of each file and review instructions to readme 2019-03-20 22:42:41 +00:00
			`As discussed in [issue #107](https://pagure.io/fedora-docs/quick-docs/issue/107),`
			`a lot of pages in this repository are in need of a technical review. Pages which need`
			`one are marked by a disclaimer on the top of the file, right below the top level heading.`
			`Any reviews are greatly appreciated. If you want to help, pick one of the pages, check it`
			`for accuracy, and then:`

			* If you find that all information on the page is correct, either open a pull request which states that you found no problems and which removes the disclaimer from the top (the `include::`) statement at the top, or open an issue against this repository stating which page you reviewed and found no errors in so we can remove it
			`* If you find errors, then either open a pull request fixing them and removing the disclaimer from the top, or open an issue and describe the errors you found, and how to fix them if you know a fix`

switch to Antora part 2018-07-27 14:38:30 +00:00			`## How to edit these documents`
initial commit 2017-10-25 21:52:14 +00:00
switch to Antora part 2018-07-27 14:38:30 +00:00			`All of this is written in AsciiDoc. It's a simple mostly-plain-text`
			`markup language. You may want to look at:`
initial commit 2017-10-25 21:52:14 +00:00

switch to Antora part 2018-07-27 14:38:30 +00:00			`* [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)`
Fix incorrect apostrophe in README.md 2021-04-28 15:45:47 +00:00			`* [AsciiDoc Writer's Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)`
switch to Antora part 2018-07-27 14:38:30 +00:00			`* [Antora Documentation](https://docs.antora.org/antora/1.0/page/)`
initial commit 2017-10-25 21:52:14 +00:00
switch to Antora part 2018-07-27 14:38:30 +00:00
			`## Local preview`

			`This repo includes scripts to build and preview the contents of this repository.`

Fix a typo 2019-01-25 11:23:46 +00:00			`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.`
switch to Antora part 2018-07-27 14:38:30 +00:00
Update README.md Added a hint on using Docker for local previews 2021-03-21 21:19:08 +00:00			`Both scripts use podman in F30 and above. Please make sure you have podman installed on your system (you can also use Docker, but on Fedora podman is recommended).`
Modified README.md to remove referrences to Docker 2019-11-06 04:00:29 +00:00
			`### Installing podman on Fedora`
			```
			`$ sudo dnf install podman`
			```
switch to Antora part 2018-07-27 14:38:30 +00:00
			`To build and preview the site, run:`

			```
			`$ ./build.sh && ./preview.sh`
			```

			`The result will be available at http://localhost:8080`