hank-test/quick-docs
1
0
Fork 0
mirror of https://pagure.io/fedora-docs/quick-docs.git synced 2024-10-18 17:26:29 +00:00
Code Issues 1 Projects Releases Packages Wiki Activity Actions

better instructions

Browse source
This commit is contained in:
Matthew Miller 2017-10-27 22:16:40 +01:00
parent 7461d4723d
commit 611ad55e85
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
en-US/index.adoc
View file

@ -1,18 +1,20 @@
Fedora Quick Docs
=================
This repository represents asciidoc documents roughly converted from the top
50 document-like pages in the Fedora Wiki. We want to move away from
exposing users to the wild territory of workspace wikis and to a nice,
topic-oriented format with a PR-based workflow.
This repository represents
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[asciidoc]
documents roughly (semi-automatically) converted from the top 50
document-like pages in the Fedora Wiki. We want to move away from exposing
users to the wild territory of workspace wikis and to a nice, topic-oriented
format with a PR-based workflow.
So, this is kind of a seed project. *Your help wanted!*
Please:
1. Pick a document to update
2. Fork the https://pagure.io/fedora-docs/quick-docs repo
3. Make your changes to the `.adoc` file you want to improve
4. Update `_topic_map.yml` to remove `(FIX ME!)`
5. Submit a pull request with your improvements
1. Pick a document to update.
2. Fork the https://pagure.io/fedora-docs/quick-docs repo.
3. Make your changes to the `.adoc` file you want to improve.
4. Update `_topic_map.yml` to remove "`(FIX ME!)`"
5. Submit a pull request with your improvements.
6. Update the original wiki page with `{{old}}` and a link to the shiny new document