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

Issue #72 - update instructions with correct map file

Browse source
This commit is contained in:
Petr Bokoc 2018-08-27 17:08:01 +02:00
parent 33c96c3ad1
commit 2a14881273
14 changed files with 20 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/ROOT/pages/autoupdates.adoc
View file

@ -17,7 +17,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/debug-dracut-problems.adoc
View file

@ -17,7 +17,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/debug-systemd-problems.adoc
View file

@ -17,7 +17,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/debug-wayland-problems.adoc
View file

@ -17,7 +17,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/edit-iptables-rules.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/enable-touchpad-click.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

14
modules/ROOT/pages/index.adoc
View file

@ -24,12 +24,13 @@ explain, you can create a new document from scratch.
== Steps
1. Pick a document to update. You can find documents needing updates in the `_topic_map.yml` file. They are on the commented lines (those that start with a `#`).
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. If migrating a wiki page, create a redirect on the old page — see below.
. Pick a document to update. You can find documents needing updates in the [filename]`modules/ROOT/nav.adoc` file. They are on the commented-out lines (those that start with a `//FIXME`).
. Fork the https://pagure.io/fedora-docs/quick-docs repo.
. Make your changes to the `.adoc` file you want to improve.
. Uncomment the file in [filename]`nav.adoc` remove the `FIXME` from the xref..
. Build a local preview to ensure your changes look the way you intended: Make sure you have *Docker* installed, and run `./build.sh && ./preview.sh`. Follow instructions printed on the command line.
. When you are satisfied with your updates, submit a pull request with your improvements.
. If migrating a wiki page, create a redirect on the old page — see below.
== Wiki Redirects
@ -58,4 +59,3 @@ https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit
Note that there is no validation that the target exists or is correct —
please double-check that any redirects you create work properly before
moving on.

2
modules/ROOT/pages/mirroring.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/openh264.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/package-management.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/packagekit-not-found.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/postgresql.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/uefi-with-qemu.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro:

2
modules/ROOT/pages/upgrading-fedora-online.adoc
View file

@ -18,7 +18,7 @@ It is probably
Pull requests accepted at https://pagure.io/fedora-docs/quick-docs
Once you've fixed this page, remove this notice, and update
`_topic_map.yml`.
[filename]`modules/ROOT/nav.adoc`.
Once the document is live, go to the original wiki page and replace its text
with the following macro: