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.
- Bump version to 1.2.0
- AR new screenshots (all of them were EN), text not updated: will need an arabic speaker.
- EN new `settings` screnshot, text update, bump to 1.2.0
- ES new `settings` screnshot, text update (untranslated), bump to 1.2.0
- FR new `settings` screnshot, text update, bump to 1.2.0
- IT new `settings` screnshot, text update (untranslated), bump to 1.2.0
- PL new `settings` screnshot, text update, bump to 1.2.0
+ 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.
