diff options
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/automating_login.rst | 21 | ||||
| -rw-r--r-- | docs/dev/environment.rst | 4 | ||||
| -rw-r--r-- | docs/dev/tests.rst | 2 | ||||
| -rw-r--r-- | docs/dev/translations.rst | 37 |
4 files changed, 61 insertions, 3 deletions
diff --git a/docs/dev/automating_login.rst b/docs/dev/automating_login.rst new file mode 100644 index 00000000..7017dd8e --- /dev/null +++ b/docs/dev/automating_login.rst @@ -0,0 +1,21 @@ +.. _automating_login: + +Automating login +================ + +There's an annoying bug with python keyring module, that makes the 'remember +login' checkbox non functional. + +That, and the need to script end-to-end tests with the client inside a docker +environment, made us put a mechanism to pass credentials via environment +variables. + +To automate login, set BITMASK_CREDENTIALS env var:: + + BITMASK_CREDENTIALS=/tmp/secrets.conf bitmask --debug + +where the pointed file looks like this:: + + [Credentials] + username = user@provider + password = mypass diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst index a3184b01..99600ec8 100644 --- a/docs/dev/environment.rst +++ b/docs/dev/environment.rst @@ -34,7 +34,7 @@ Bitmask depends on these base libraries: Debian ^^^^^^ -In debian-based systems, you can get everything you need: +In Debian-based systems, you can get everything you need: .. include:: quickstart.rst :start-after: begin-debian-deps @@ -82,7 +82,7 @@ Avoid compiling PySide inside a virtualenv If you attempt to install PySide inside a virtualenv as part of the rest of the dependencies using pip, basically it will take ages to compile. -As a workaround, you can run the following script after creating your virtualenv. It will symlink to your global PySide installation (*this is the recommended way if you are running a debian-based system*):: +As a workaround, you can run the following script after creating your virtualenv. It will symlink to your global PySide installation (*this is the recommended way if you are running a Debian-based system*):: (bitmask)$ pkg/postmkvenv.sh diff --git a/docs/dev/tests.rst b/docs/dev/tests.rst index d55c206a..bdefcfdc 100644 --- a/docs/dev/tests.rst +++ b/docs/dev/tests.rst @@ -16,7 +16,7 @@ Testing dependencies have a look at ``pkg/test-requirements.pip`` The ``./run_tests.sh`` command should install all of them in your virtualenv for you. -If you prefer to install them system wide, this should do in a debian system:: +If you prefer to install them system wide, this should do in a Debian system:: $ apt-get install python-nose python-mock python-coverage diff --git a/docs/dev/translations.rst b/docs/dev/translations.rst new file mode 100644 index 00000000..58a2a8fb --- /dev/null +++ b/docs/dev/translations.rst @@ -0,0 +1,37 @@ +.. _translations: + +Internationalization +==================== + +This part of the documentation covers the localization and translation of Bitmask. +Because we want to *bring fire to the people*, in as many countries and languages as possible. + +Translating Bitmask PySide Application +-------------------------------------- + +.. raw:: html + + <div><a target="_blank" style="text-decoration:none; color:black; font-size:66%" href="https://www.transifex.com/projects/p/bitmask/resource/bitmask/" title="See more information on Transifex.com">Top translations: bitmask ยป bitmask</a><br/><img border="0" src="https://www.transifex.com/projects/p/bitmask/resource/bitmask/chart/image_png"/><br/><a target="_blank" href="https://www.transifex.com/"><img border="0" src="https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png"/></a></div> + + +For translators +^^^^^^^^^^^^^^^ + +We are using `transifex <http://transifex.com/projects/p/bitmask>`_ to coordinate translation efforts. If you want to contribute, just sign up there and send us your translations. + + +Translating help documents +-------------------------- + +There are two sets of online documents that need translation. One is +https://leap.se/docs, and the other is https://bitmask.net/help. Both are +maintained in git repos (`leap.se <https://github.com/leapcode/leap_se/tree/master/pages/docs>`_ and `bitmask.net <https://github.com/leapcode/bitmask_help>`_). + +In the repo for bitmask.net there are some explanations about how to contribute +to those repos (using the online github editor, or using git directly). + + +Human interaction +----------------- +We're hanging out in the #leap channel on the freenode network. There's also a +spanish channel at #bitmask-es. |