diff options
Diffstat (limited to 'pages/docs/client')
-rw-r--r-- | pages/docs/client/en.md | 11 | ||||
-rw-r--r-- | pages/docs/client/testers-howto.md | 21 | ||||
-rw-r--r-- | pages/docs/client/user-install.md | 62 |
3 files changed, 70 insertions, 24 deletions
diff --git a/pages/docs/client/en.md b/pages/docs/client/en.md index 15c55bf..ff7c826 100644 --- a/pages/docs/client/en.md +++ b/pages/docs/client/en.md @@ -2,7 +2,7 @@ @title = 'Bitmask' @summary = "The Internet Encryption Toolkit: Encrypted Internet Proxy and Encrypted Mail" -**Bitmask** is the multiplatform desktop client for the services offered by [the LEAP Platform](platform). +**Bitmask** is the multiplatform desktop client for the services offered by [[the LEAP Platform => platform]]. For more information, see [[bitmask.net => https://bitmask.net]]. It is written in python using [PySide](http://qt-project.org/wiki/PySide) and licensed under the GPL3. Currently we distribute pre-compiled bundles for Linux and OSX, with Windows bundles following soon. @@ -10,22 +10,23 @@ We include below some sections of the user guide and the development documentati User Guide ---------- -* [Installing Bitmask](client/user-install) -* [Running Bitmask](client/user-running) + +* [[Installing Bitmask => user-install]] +* [[Running Bitmask => user-running]] Tester Guide ------------ This part of the documentation details how to fetch the last development version and how to report bugs. -* [Howto for testers](client/testers-howto) +* [[HOWTO for testers => testers-howto]] Hackers Guide ------------- If you want to contribute to the project, we wrote this for you. -* [Setting up a development environment](client/dev-environment) +* [[Setting up a development environment => dev-environment]] <!-- diff --git a/pages/docs/client/testers-howto.md b/pages/docs/client/testers-howto.md index 9e6ff7d..e09549e 100644 --- a/pages/docs/client/testers-howto.md +++ b/pages/docs/client/testers-howto.md @@ -1,12 +1,5 @@ @nav_title = "Testing" -@title = "Howto for Testers" - -This document covers a how-to guide to: - -1. Where and how report bugs for Bitmask \<reporting\_bugs\>, and -2. Quickly fetching latest development code \<fetchinglatest\>. - -Let's go! +@title = "HOWTO for Testers" Reporting bugs -------------- @@ -18,10 +11,8 @@ way to get it fixed quickly, and get our unconditional gratitude. It is quick, easy, and probably the best way to contribute to Bitmask development, other than submitting patches. -> **Reporting better bugs** -> -> New to bug reporting? Here you have a [great document about this noble -> art](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html). +**Reporting better bugs:** New to bug reporting? Here you have a +[great document about this noble art](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html). ### Where to report bugs @@ -80,9 +71,9 @@ web](http://webchat.freenode.net/?nick=leaper....&channels=%23leap&uio=d4). Fetching latest development code -------------------------------- -Normally, testing the latest client bundles \<standalone-bundle\> should -be enough. We are engaged in a three-week release cycle with minor -releases that are as stable as possible. +Normally, testing the latest client bundles should be enough. We are engaged +in a three-week release cycle with minor releases that are as stable as +possible. However, if you want to test that some issue has *really* been fixed before the next release is out (if you are testing a new provider, for diff --git a/pages/docs/client/user-install.md b/pages/docs/client/user-install.md index 173a9c5..830c4ca 100644 --- a/pages/docs/client/user-install.md +++ b/pages/docs/client/user-install.md @@ -1,7 +1,7 @@ @nav_title = 'Installing' @title = 'Installing Bitmask' -For download links and installation instructions go to https://dl.bitmask.net/ +For download links and installation instructions go to [[dl.bitmask.net => https://dl.bitmask.net/]]. Distribute & Pip ---------------- @@ -9,11 +9,65 @@ Distribute & Pip **Note** If you are familiar with python code and you can find your way through the -process of dependencies install, you can installing Bitmask using [pip](http://www.pip-installer.org/) -for the already released versions : +process of dependencies install, you can installing Bitmask using +[[pip => http://www.pip-installer.org/]] for the already released versions: $ pip install leap.bitmask +Our release cycle +----------------- + +Once we have all features that we have planned for the next release of bitmask +ready we build a **release candidate** bundle. This bundle is heavily tested +before becoming stable. Here your contribution is important, we can not imagine +all they ways people uses bitmask, we need you to try it out, break it and +report back to us the problems. Read the [[Bundle QA +section => bundle-testing]] to learn how to help. + +After extensive testing and being fixed all blocking issues we release the +**stable** bundle, what is meant for public consumption. This is the bundle that +is linked for download from the [[bitmask.net => https://bitmask.net]] website. + +You can find all the bundles at [[dl.bitmask.net/client => https://dl.bitmask.net/client/]]. + +Automatic upgrades +------------------ + +The bundle uses [[The Update Framework => http://theupdateframework.com/]] (TUF) for +upgrades. If there is an upgrade available it will download it in background +when bitmask is running and ask you to restart bitmask to apply it. + +We have two TUF repositories: + +- **stable**. For the stable bundles. This allows the released bundles to + upgrade to the next version automatically. +- **unstable**. For the *release candidate* (RC) bundles. The RC bundles + upgrade automatically to the next RC bundle that we release, but never to + the stable one. For example, if you are using the 0.7.0RC6 (the latest RC + bundle for the 0.7.0 version) you will not be upgraded to 0.7.0 but the next + RC bundle released (e.g. 0.7.1RC1). The last RC bundle will be the same as + the final release for that version number, except that it will be pinned + to get future TUF updates from the unstable repository. + +Packages +-------- + +For debian and ubuntu we build native packages and distribute them in our own +repositories. We have **stable** and **experimental** packages, experimental +packages are meant for testing, like the *release candidate* bundles. + +The repository url looks like: + + deb http://deb.leap.se/[debian|experimental] [utopic|trusty|wheezy|jessy|sid] main + +- **debian** are for stable packages. +- **experimental** are for experimental packages. +- **utopic** and **trusty** are the ubuntu versions. +- **wheezy**, **jessy** and **sid** are the debian versions. + +More details on how to configure the repositories in your system in +https://dl.bitmask.net/linux/ + Show me the code! ----------------- @@ -26,5 +80,5 @@ Or from the github mirror : $ git clone https://github.com/leapcode/bitmask_client.git -For more information go to the [Hacking](client/dev-environment) section :) +For more information go to the [[Hacking => client/dev-environment]] section :) |