commit a0dbe938c38e902681f0b901285c8d978ca101e7
parent a15b44db4fab3ad986142c0b0fce5ec6d2e28974
Author: Christian Grothoff <christian@grothoff.org>
Date: Mon, 2 Sep 2024 11:34:56 +0200
fix build warnings
Diffstat:
2 files changed, 28 insertions(+), 15 deletions(-)
diff --git a/design-documents/056-weblate-integration.rst b/design-documents/056-weblate-integration.rst
@@ -140,11 +140,14 @@ What we need to do to reduce the work load in the translators side
1. devs and Weblate maintainers look into DD53 + Weblate maintainers take care of checks and keep the repos consistent and up-to-date
2. translators know the apps and strings very well and manage ambiguities
-3. translators and reviewers take a look at the context
- message ID / key,
- string location in the source code / "nearby strings",
- comments,
- the history of string changes
+3. translators and reviewers take a look at:
+
+ * the context message ID / key
+ * string location in the source code
+ * "nearby strings"
+ * comments
+ * the history of string changes
+
4. devs and Weblate maintainers add screenshots to ambiguous strings
5. devs add context via msgctxt through the pogen script
diff --git a/system-administration/writing-documentation-setup.rst b/system-administration/writing-documentation-setup.rst
@@ -28,10 +28,14 @@ How to publish your contributions
=================================
* We broadly use git for almost everything.
-* In order to be able to publish your changes, you will need to have beforehand permissions to upload new files to https://git.taler.net/docs.git repository.
-* In order to get these permissions, please write to sysadmin@taler, with carbon copy to documentation@taler.net.
-Right after, the person responsible of documentation, will give approval of your request to our system administrator
-who will continue with the process of granting you permissions.
+* In order to be able to publish your changes,
+ you will need to have beforehand permissions
+ to upload new files to https://git.taler.net/docs.git repository.
+* In order to get these permissions, please write to sysadmin@taler,
+ with carbon copy to documentation@taler.net.
+ Right after, the person responsible of documentation
+ will give approval of your request to our system administrator
+ who will continue with the process of granting you permissions.
* Please have your public SSH key ready, as it will be requested.
Skills required
@@ -44,7 +48,7 @@ Software requirements
=====================
In order to be able to write rst file in your own computer, and check the RST syntax before
-uploading your content, you will have to have locally installed in your computer the next programs.
+uploading your content, you will have to have locally installed in your computer the next programs.
* Git
* Python3
@@ -75,7 +79,8 @@ Please log in your terminal as the "root" user:
Git clone the documentation repository
======================================
-From your preferred folder location, you can now git clone the whole documentation respository.
+From your preferred folder location,
+you can now git clone the whole documentation respository.
.. code-block::
@@ -100,13 +105,14 @@ If you find any highlighted errors in red, please fix them.
Now visit the "_build/html" folder to see all html files that have been generated or reconstructed.
-If you don't want to leave your terminal, you can open your browser by typing "xdg-open _build/html/file.html",
+If you don't want to leave your terminal,
+you can open your browser by typing "xdg-open _build/html/file.html",
otherwise you can use your web browser to see your files.
Publish your changes
====================
-Within the docs.git folder you can check and upload your work using basic git commands.
+Within the docs.git folder you can check and upload your work using basic git commands.
.. code-block::
@@ -118,5 +124,9 @@ Within the docs.git folder you can check and upload your work using basic git co
$ git log # Check your commit has been done properly
$ git push origin master # Upload your content
-- After uploading your changes to the docs.git.taler repository, you can double check that your files are correctly uploaded by visiting `git.taler.net/docs.git <https://git.taler.net/docs.git>`_.
-Please wait a few minutes to visit the docs.git.taler.net website, until our Buildbot builds your latest contributions. Thank you.
+After uploading your changes to the docs.git.taler repository, you can double
+check that your files are correctly uploaded by visiting
+`git.taler.net/docs.git <https://git.taler.net/docs.git>`_.
+
+Please wait a few minutes to visit the docs.git.taler.net website, until our
+Buildbot builds your latest contributions. Thank you.
