PR#77: Issue #72 - update instructions with correct map file - fedora-docs/quick-docs

fedora-docs / quick-docs

#77 Issue #72 - update instructions with correct map file

Merged 5 years ago by mjahoda. Opened 5 years ago by pbokoc.

fedora-docs/ pbokoc/quick-docs 72 into master

Issue #72 - update instructions with correct map file

Petr Bokoc • 5 years ago

2a14881

modules/ROOT/pages/autoupdates.adoc

file modified

+1 -1

		`@@ -17,7 +17,7 @@`
		`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:`

modules/ROOT/pages/debug-dracut-problems.adoc

file modified

+1 -1

		`@@ -17,7 +17,7 @@`
		`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:`

modules/ROOT/pages/debug-systemd-problems.adoc

file modified

+1 -1

		`@@ -17,7 +17,7 @@`
		`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:`

modules/ROOT/pages/debug-wayland-problems.adoc

file modified

+1 -1

		`@@ -17,7 +17,7 @@`
		`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:`

modules/ROOT/pages/edit-iptables-rules.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/enable-touchpad-click.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/index.adoc

file modified

+7 -7

		`@@ -24,12 +24,13 @@`

		`== 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 @@`
		`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.`
		`-`

modules/ROOT/pages/mirroring.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/openh264.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/package-management.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/packagekit-not-found.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/postgresql.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/uefi-with-qemu.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

modules/ROOT/pages/upgrading-fedora-online.adoc

file modified

+1 -1

		`@@ -18,7 +18,7 @@`
		`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:`

pbokoc commented 5 years ago

Changed the contributor instructions in index.adoc and in the disclaimer on top of unfixed pages so they now direct people to edit nav.adoc instead of _topic_map.yml when reincluding fixed content.

Fixes #72.