mirror of
https://github.com/monero-project/monero-site.git
synced 2024-12-04 23:51:11 +02:00
4e5143db60
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.
24 lines
1.0 KiB
HTML
24 lines
1.0 KiB
HTML
{% assign disclaimer = "" %}
|
|
|
|
<!-- If the English version is outdated, all versions (for all languages) will be outdated. No need to check the state of the translations. -->
|
|
{% if page.outdated %}
|
|
<div class="disclaimer">
|
|
<p>{% t global.outdated %}</p>
|
|
</div>
|
|
|
|
<!-- If page is translated but the English version got updated, the translation is outdated -->
|
|
{% elsif include.translationOutdated == "yes" %}
|
|
{% capture disclaimer %}{% t global.outdatedMin %} <a class="disclaimer-link" href="{{ site.baseurl_root }}{{ page.url }}" >{% t global.outdatedVersion %}</a>.{% endcapture %}
|
|
|
|
<!-- The page is not translated -->
|
|
{% elsif include.translated == "no" %}
|
|
{% capture disclaimer %}{% t global.untranslated %} <a class="disclaimer-link" href="https://github.com/monero-project/monero-site/blob/master/README.md">README</a>{% endcapture %}
|
|
|
|
{% endif %}
|
|
|
|
<!-- Print the disclaimer if not empty and not English -->
|
|
{% if disclaimer != "" and site.lang != "en" %}
|
|
<div class="disclaimer">
|
|
<p>{{ disclaimer }}</p>
|
|
</div>
|
|
{% endif %} |