summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/quickstart.rst23
-rw-r--r--docs/dev/translation.rst13
2 files changed, 29 insertions, 7 deletions
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index 74bb52960..8132bccc4 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -29,7 +29,7 @@ If you implement themes, you will need to compile styles and JavaScript before
.. code:: sh
- make themes
+ make themes.all
Don't forget to install npm_ first.
@@ -53,3 +53,24 @@ Don't forget to install npm_ first.
sudo -H dnf install npm
+If you finished your *tests* you can start to commit your changes. To separate
+the changed code from the build products first run:
+
+.. code:: sh
+
+ make static.build.restore
+
+This will restore the old build products and only your changes of the code
+remain in the working tree which can now be added & commited. When all sources
+are commited, you can commit the build products simply by:
+
+.. code:: sh
+
+ make static.build.commit
+
+Commiting the build products should be the last step, just before you send us
+your PR. There is also a make target to rewind this last build commit:
+
+.. code:: sh
+
+ make static.build.drop
diff --git a/docs/dev/translation.rst b/docs/dev/translation.rst
index 86c4c843b..523dcf78c 100644
--- a/docs/dev/translation.rst
+++ b/docs/dev/translation.rst
@@ -12,7 +12,6 @@ Requirements
============
* Transifex account
-* Installed CLI tool of Transifex
Init Transifex project
======================
@@ -22,7 +21,7 @@ initialize the project.
.. code:: sh
- tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
+ ./manage pyenv.cmd tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
After ``$HOME/.transifexrc`` is created, get a Transifex API key and insert it
@@ -45,8 +44,9 @@ Then run ``tx set``:
.. code:: shell
- tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \
- --source-lang en --type PO --source-file messages.pot --execute
+ ./manage pyenv.cmd tx set --auto-local \
+ -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \
+ --source-lang en --type PO --source-file messages.pot --execute
Update translations
@@ -56,7 +56,8 @@ To retrieve the latest translations, pull it from Transifex.
.. code:: sh
- tx pull -a
+ ./manage pyenv.cmd tx pull -a
+ [?] Enter your api token: ....
Then check the new languages. If strings translated are not enough, delete those
folders, because those should not be compiled. Call the command below to compile
@@ -64,7 +65,7 @@ the ``.po`` files.
.. code:: shell
- pybabel compile -d searx/translations
+ ./manage pyenv.cmd pybabel compile -d searx/translations
After the compilation is finished commit the ``.po`` and ``.mo`` files and