summaryrefslogtreecommitdiff
path: root/pages/docs/client
diff options
context:
space:
mode:
authorRuben Pollan <meskio@sindominio.net>2015-03-31 12:37:27 +0200
committerRuben Pollan <meskio@sindominio.net>2015-03-31 12:42:37 +0200
commit353589130ad8a1b8e09b74ac97cc74ca1bc6754a (patch)
treec3fe9ace74dc7563eeba55d30469a1908d94a925 /pages/docs/client
parentf067e2bb0252693fc473f7f34d55b45518698afa (diff)
[docs] Add documentation about our release cycle
Resolves: #6619
Diffstat (limited to 'pages/docs/client')
-rw-r--r--pages/docs/client/user-install.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/pages/docs/client/user-install.md b/pages/docs/client/user-install.md
index 173a9c5..ae9ba64 100644
--- a/pages/docs/client/user-install.md
+++ b/pages/docs/client/user-install.md
@@ -14,6 +14,58 @@ 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](/docs/client/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 in the [bitmask web](https://bitmask.net/).
+
+You can find all the bundles at 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. The latest RC bundle should be exactly the same than the stable
+ version with the difference of the TUF repos that are configured in them.
+
+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!
-----------------