Commit 88aeb964 authored by qubenix's avatar qubenix

Alphabetize user guides page.

Put user guide entries and categories into alphabetic order.
Mention alphabetic order in README in two spots.
Nit: remove empty space from README at the end of line 176.
parent 62bfe046
......@@ -138,7 +138,7 @@ You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure
* Write User Guide
* Copy User Guide file to ALL LANGUAGES in /_i18n/[ALL LANGUAGES]/resources/user-guides
* Paste `{% include untranslated.html %}` into the top of each language version of your User Guide, except the original language
* Add guide using markdown in the correct category in ALL LANGUAGES to /_i18n/[ALL LANGUAGES]/resources/user-guides/index.md being careful not to mess with any indentation
* Add guide using markdown in the correct category, and in alphabetic order, in ALL LANGUAGES to /_i18n/[ALL LANGUAGES]/resources/user-guides/index.md being careful not to mess with any indentation
* Test/Build
* Submit PR
......@@ -173,13 +173,13 @@ As you paste into each folder, open up the file and paste the following snippet
`{% include untranslated.html %}`. This does not need to be done in the original language that the User Guide was written in.
### 5.7 Add Guide to the 'User Guide' landing page of EACH LANGUAGE
In the /_i18n/[ORIGINAL LANGUAGE OF USER GUIDE]/resources/user-guides folder, find the file labeled index.md and open it.
In the /_i18n/[ORIGINAL LANGUAGE OF USER GUIDE]/resources/user-guides folder, find the file labeled index.md and open it.
DO NOT CHANGE ANYTHING IN THIS DOCUMENT BESIDES WHAT YOU ARE INSTRUCTED TO.
This file will look quite different because it's HTML. Don't panic. Simply Ctrl + F (i.e. the find feature) and search for the category that you want to put your User Guide in. You will see there are some sections that are not indented like the others. They are flush with the left side of the screen. **Do not change the indentation.** You can put markdown in these areas.
Once you've identified the non-indented area under the category you would like your User Guide to be under, you can use markdown to insert your link underneath the others. `[TITLE OF USER GUIDE]({{site.baseurl}}/LINK-TO-USER-GUIDE.html)`. Please note that the file name in between the parentheses must be EXACTLY the same name as the permalink you made in step 5.3, but with a `.html` at the end instead of `.md` and the snippet `{{site.baseurl}}/` before the link.
Once you've identified the non-indented area under the category you would like your User Guide to be under, you can use markdown to insert your link with the others in alphabetic order. `[TITLE OF USER GUIDE]({{site.baseurl}}/LINK-TO-USER-GUIDE.html)`. Please note that the file name in between the parentheses must be EXACTLY the same name as the permalink you made in step 5.3, but with a `.html` at the end instead of `.md` and the snippet `{{site.baseurl}}/` before the link.
In the event that you think your User Guide should be in a new Category that doesn't exist yet, contact rehrar to make one for you.
......
......@@ -10,10 +10,10 @@
</div>
<div class="row start-xs" markdown="1">
[Monero Tools]({{site.baseurl}}/resources/user-guides/monero_tools.html)
[How to make an offline backup]({{site.baseurl}}/resources/user-guides/Offline_Backup.html)
[Importing the Monero blockchain]({{site.baseurl}}/resources/user-guides/importing_blockchain.html)
[How to run a node on VPS]({{site.baseurl}}/resources/user-guides/vps_run_node.html)
[Importing the Monero blockchain]({{site.baseurl}}/resources/user-guides/importing_blockchain.html)
[Monero Tools]({{site.baseurl}}/resources/user-guides/monero_tools.html)
[Securely purchasing and storing Monero]({{site.baseurl}}/resources/user-guides/securely_purchase.html)
</div>
......@@ -23,17 +23,14 @@
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Wallets</h2>
<h2>Mining</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[Getting started with the CLI wallet]({{site.baseurl}}/resources/user-guides/monero-wallet-cli.html)
[How to make a view-only wallet]({{site.baseurl}}/resources/user-guides/view_only.html)
[How to prove payment]({{site.baseurl}}/resources/user-guides/prove-payment.html)
[Restoring wallet from keys]({{site.baseurl}}/resources/user-guides/restore_from_keys.html)
[How to connect to a remote node within GUI wallet]({{site.baseurl}}/resources/user-guides/remote_node_gui.html)
[CLI wallet/daemon isolation with Qubes + Whonix]({{site.baseurl}}/resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.html)
[How to mine on a pool with xmr-stak-cpu]({{site.baseurl}}/resources/user-guides/mine-to-pool.html)
[How to solo mine with the GUI]({{site.baseurl}}/resources/user-guides/solo_mine_GUI.html)
[Mining with Docker and XMRig]({{site.baseurl}}/resources/user-guides/mining_with_xmrig_and_docker.html)
</div>
</div>
......@@ -62,14 +59,17 @@
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Mining</h2>
<h2>Wallets</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[How to solo mine with the GUI]({{site.baseurl}}/resources/user-guides/solo_mine_GUI.html)
[How to mine on a pool with xmr-stak-cpu]({{site.baseurl}}/resources/user-guides/mine-to-pool.html)
[Mining with Docker and XMRig]({{site.baseurl}}/resources/user-guides/mining_with_xmrig_and_docker.html)
[CLI wallet/daemon isolation with Qubes + Whonix]({{site.baseurl}}/resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.html)
[Getting started with the CLI wallet]({{site.baseurl}}/resources/user-guides/monero-wallet-cli.html)
[How to connect to a remote node within GUI wallet]({{site.baseurl}}/resources/user-guides/remote_node_gui.html)
[How to make a view-only wallet]({{site.baseurl}}/resources/user-guides/view_only.html)
[How to prove payment]({{site.baseurl}}/resources/user-guides/prove-payment.html)
[Restoring wallet from keys]({{site.baseurl}}/resources/user-guides/restore_from_keys.html)
</div>
</div>
......
......@@ -11,10 +11,10 @@
</div>
<div class="row start-xs" markdown="1">
[Monero Tools]({{site.baseurl}}/resources/user-guides/monero_tools.html)
[How to make an offline backup]({{site.baseurl}}/resources/user-guides/Offline_Backup.html)
[Importing the Monero blockchain]({{site.baseurl}}/resources/user-guides/importing_blockchain.html)
[How to run a node on VPS]({{site.baseurl}}/resources/user-guides/vps_run_node.html)
[Importing the Monero blockchain]({{site.baseurl}}/resources/user-guides/importing_blockchain.html)
[Monero Tools]({{site.baseurl}}/resources/user-guides/monero_tools.html)
[Securely purchasing and storing Monero]({{site.baseurl}}/resources/user-guides/securely_purchase.html)
</div>
......@@ -24,17 +24,14 @@
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Wallets</h2>
<h2>Mining</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[Getting started with the CLI wallet]({{site.baseurl}}/resources/user-guides/monero-wallet-cli.html)
[How to make a view-only wallet]({{site.baseurl}}/resources/user-guides/view_only.html)
[How to prove payment]({{site.baseurl}}/resources/user-guides/prove-payment.html)
[Restoring wallet from keys]({{site.baseurl}}/resources/user-guides/restore_from_keys.html)
[How to connect to a remote node within GUI wallet]({{site.baseurl}}/resources/user-guides/remote_node_gui.html)
[CLI wallet/daemon isolation with Qubes + Whonix]({{site.baseurl}}/resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.html)
[How to mine on a pool with xmr-stak-cpu]({{site.baseurl}}/resources/user-guides/mine-to-pool.html)
[How to solo mine with the GUI]({{site.baseurl}}/resources/user-guides/solo_mine_GUI.html)
[Mining with Docker and XMRig]({{site.baseurl}}/resources/user-guides/mining_with_xmrig_and_docker.html)
</div>
</div>
......@@ -63,14 +60,17 @@
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Mining</h2>
<h2>Wallets</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[How to solo mine with the GUI]({{site.baseurl}}/resources/user-guides/solo_mine_GUI.html)
[How to mine on a pool with xmr-stak-cpu]({{site.baseurl}}/resources/user-guides/mine-to-pool.html)
[Mining with Docker and XMRig]({{site.baseurl}}/resources/user-guides/mining_with_xmrig_and_docker.html)
[CLI wallet/daemon isolation with Qubes + Whonix]({{site.baseurl}}/resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.html)
[Getting started with the CLI wallet]({{site.baseurl}}/resources/user-guides/monero-wallet-cli.html)
[How to connect to a remote node within GUI wallet]({{site.baseurl}}/resources/user-guides/remote_node_gui.html)
[How to make a view-only wallet]({{site.baseurl}}/resources/user-guides/view_only.html)
[How to prove payment]({{site.baseurl}}/resources/user-guides/prove-payment.html)
[Restoring wallet from keys]({{site.baseurl}}/resources/user-guides/restore_from_keys.html)
</div>
</div>
......
......@@ -11,10 +11,10 @@
</div>
<div class="row start-xs" markdown="1">
[Monero Tools]({{site.baseurl}}/resources/user-guides/monero_tools.html)
[How to make an offline backup]({{site.baseurl}}/resources/user-guides/Offline_Backup.html)
[Importing the Monero blockchain]({{site.baseurl}}/resources/user-guides/importing_blockchain.html)
[How to run a node on VPS]({{site.baseurl}}/resources/user-guides/vps_run_node.html)
[Importing the Monero blockchain]({{site.baseurl}}/resources/user-guides/importing_blockchain.html)
[Monero Tools]({{site.baseurl}}/resources/user-guides/monero_tools.html)
[Securely purchasing and storing Monero]({{site.baseurl}}/resources/user-guides/securely_purchase.html)
</div>
......@@ -24,17 +24,14 @@
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Wallets</h2>
<h2>Mining</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[Getting started with the CLI wallet]({{site.baseurl}}/resources/user-guides/monero-wallet-cli.html)
[How to make a view-only wallet]({{site.baseurl}}/resources/user-guides/view_only.html)
[How to prove payment]({{site.baseurl}}/resources/user-guides/prove-payment.html)
[Restoring wallet from keys]({{site.baseurl}}/resources/user-guides/restore_from_keys.html)
[How to connect to a remote node within GUI wallet]({{site.baseurl}}/resources/user-guides/remote_node_gui.html)
[CLI wallet/daemon isolation with Qubes + Whonix]({{site.baseurl}}/resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.html)
[How to mine on a pool with xmr-stak-cpu]({{site.baseurl}}/resources/user-guides/mine-to-pool.html)
[How to solo mine with the GUI]({{site.baseurl}}/resources/user-guides/solo_mine_GUI.html)
[Mining with Docker and XMRig]({{site.baseurl}}/resources/user-guides/mining_with_xmrig_and_docker.html)
</div>
</div>
......@@ -63,14 +60,17 @@
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Mining</h2>
<h2>Wallets</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[How to solo mine with the GUI]({{site.baseurl}}/resources/user-guides/solo_mine_GUI.html)
[How to mine on a pool with xmr-stak-cpu]({{site.baseurl}}/resources/user-guides/mine-to-pool.html)
[Mining with Docker and XMRig]({{site.baseurl}}/resources/user-guides/mining_with_xmrig_and_docker.html)
[CLI wallet/daemon isolation with Qubes + Whonix]({{site.baseurl}}/resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.html)
[Getting started with the CLI wallet]({{site.baseurl}}/resources/user-guides/monero-wallet-cli.html)
[How to connect to a remote node within GUI wallet]({{site.baseurl}}/resources/user-guides/remote_node_gui.html)
[How to make a view-only wallet]({{site.baseurl}}/resources/user-guides/view_only.html)
[How to prove payment]({{site.baseurl}}/resources/user-guides/prove-payment.html)
[Restoring wallet from keys]({{site.baseurl}}/resources/user-guides/restore_from_keys.html)
</div>
</div>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment