Commit Graph

5 Commits

Author SHA1 Message Date
erciccione
4e5143db60
Simplify versioning system for user guides
This new approach doesn't require version numbers and make easier for contributors to understand the status
of the document. There are only 3 states:

- Outdated: The page is outdated and might not work as expected
- Untranslated: The page needs to be translated
- Translation outdated: The page is translated, but the original (English) document has been updated

To mark a guide as outdated, we change the boolean of the front matter entry 'outdated' in /resources/user-guides/GUIDE.
If 'False', the guide is updated. If 'True' all versions of the guide (English included) will show a warning at the bottom
of the page.

The other 2 states are related to the status of the translated pages and we control them from the language-specific
user guides: /_i18n/LANG/resources/user-guides/GUIDE. At the top of the page a snippet will include 2 parameters:

- translated: "yes" if the page is translated, "no" if it's not.
- translationOutdated: "yes" if the translation is outdated, "no" if it's not

This new system aims to be simpler than the precedent, avoiding to compare versioning numbers and using a higher level
system instead (yes, no, True, False). I also removed the middle way status 'only minor changes', because if there are
only minor changes that don't affect the usability of the guide, we don't need to point it out.

The old system was complex and people didn't use it. These changes will hopefully make things easier for translators and
other contributors.
2020-05-31 09:23:16 +02:00
erciccione
2f355c2bcb
adapt user and dev guides to new system removing/editing headers 2019-09-04 16:00:53 +02:00
lh1008
8ffae945ed Proof-reading user-guide/ledger-wallet-cli.md word "original" fix 2018-08-08 18:44:46 -05:00
lh1008
7565f1bc9d Proof reading ledger-wallet-cli.md guide fix word
Proof reading ledger-wallet-cli.md guide fix word
2018-08-02 18:32:15 -05:00
el00ruobuob
9845edd0d8
Ledger Wallet CLi guide
+ Based on [dEBRUYNE StackExchange Post](https://monero.stackexchange.com/questions/8503/how-do-i-generate-a-ledger-monero-wallet-with-the-cli-monero-wallet-cli)
+ De-personalized (s/"I"/"We"/g)
+ Download links moved to getmonero.org instead of GitHub
+ Typo Correction
  - Mac OS referring to GUI 0.12.1.0 instead of CLI 0.12.2.0
  - Monero v0.12.1.0 mentioned instead of v0.12.2.0
  - s/cavaet/caveat/g
+ Precision on installation section of Ledger Monero app guide for windows
+ Update the "need assistance" final note to link to the StackExchange answer.
+ Update to latest edit from @dEBRUYNE-1 on 2018/06/06
+ Corrections after review
+ consistency checks
2018-07-18 00:09:58 +02:00