Docs/quick-docs
2
0
Fork 0
Code Issues 48 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Add 'unverified' banner on top of each file and review instructions to readme

Browse source
This commit is contained in:
Petr Bokoc 2019-03-20 23:42:41 +01:00
parent f445cb1eab
commit aa9f1e8159
76 changed files with 237 additions and 76 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,6 @@
# Fedora Quick Docs
This is the content repository for the 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
@ -10,6 +10,17 @@ 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).
## Rewievers 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