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
01cd52cbd9
Add generated titles for user guides 2019-09-04 16:00:45 +02:00
el00ruobuob
4c1e8dd858
Moneropedia relocalized
+ correction on Italian Account
+ Removed leftover miners.md (replaced by mining.md)
+ Removed Dust and update Copyright
+ Code improvement to avoid reading the config file and to use the builtin jekyll config variable passed in the content
+ Ammount.md:25/26 glitch "\@transaction-privacy" corrected. PL to be checked twice.
+ Italian ammount.md moneropedia links corrected (terms added to destination entries, unnecessary markdown links removed)
+ Polish corrections
+ extend ruby \word-boundary in regex to match `-based` `-like` `-form`
+ Updated readme according to the new way to add or translate a moneropedia entry
+ fix mining with CryptoNight variant
+ rebased to include AR
+ chery picked #820 to avoid conflicts
2018-08-03 06:34:28 +02:00
el00ruobuob
9843b58674
Guides versioning
+ All guides are version
+ Major diff on Polish daemon RPC guide
+ Minor diff on Polish daemon RPC guide
+ yml completed for en, fr, pl, it, es
+ Instructions updated on readme.md:
  - For Guide création: adding the mainversion to the /ressources/user-guides, the guide version and the translation snippet to the localized files
  - For Guides update: how, where and why handling the version number.
2018-07-08 15:05:49 +02:00
qubenix
7edf03f77d
Add Windows binary verification guide, fix errors
Add user-guide for Windows binary verification, add entry to index.md, and add images to png/ dir.

Fix some jekyll serve errors pertaining to the Qubes/Whonix isolation guide:
+ In resources/user-guides/cli_wallet_daemon_isolation_qubes_whonix.md change from `static_page` to `user-guide`. Fixes error: `Missing i18n key: en:CLI Wallet/Daemon Isolation with Qubes + Whonix`.
+ Qubes/Whonix guide was missing from Italian lang section, prevented serving site. Apparently this also alphabetized the Italian lang sections index when I copied an index.md from another lang there.
2018-03-14 09:15:47 -06:00