Commit dde5904b authored by Adrien Béraud's avatar Adrien Béraud

docs: rename to Jami

Change-Id: I33cb4cfcb424c79213b58fcc6cfb40a1506df3d8
parent 221fee73
ring-project
jami-project
============
This repository is the master repository for Ring. It contains a build script, make-ring.py,
This repository is the master repository for Jami. It contains a build script, make-ring.py,
that can be used to build and install ring from source on different platforms.
More documentation can be found on http://docs.ring.cx. You may also build the documentation
More documentation can be found on http://docs.jami.net. You may also build the documentation
with ``make docs``. The documentation will be built in ``docs/build/html``.
Using make-ring
......@@ -13,7 +13,7 @@ Using make-ring
Dependencies
------------
The Ring installer uses python3. Please make sure it is installed before running it.
The Jami installer uses python3. Please make sure it is installed before running it.
Initialize the repositories
---------------------------
......@@ -25,7 +25,7 @@ Initialize the repositories
It initializes and updates the submodules to set them at the top of their master branch. This
is ideal to have the latest development version.
However, in order to build a specific version of Ring, such as the Production one, please use
However, in order to build a specific version of Jami, such as the Production one, please use
.. code-block:: bash
......
......@@ -4,15 +4,15 @@ Contributing
============
Ring loves external contributions but we do not use the Github PR system.
Instead, we host a public gerrit server: https://gerrit-ring.savoirfairelinux.com
Instead, we host a public gerrit server: https://review.jami.net
Before submitting a contribution, you need to register on our Gerrit server
either with your Github or Google account.
Head to the settings section to set one of the following:
- http password and username: https://gerrit-ring.savoirfairelinux.com/#/settings/http-password
- ssh key: https://gerrit-ring.savoirfairelinux.com/#/settings/ssh-keys
- http password and username: https://review.jami.net/#/settings/http-password
- ssh key: https://review.jami.net/#/settings/ssh-keys
In each Ring submodule there is a ``.gitreview`` file. It contains all the
necessary info to send a patchset to our gerrit server.
......@@ -29,7 +29,7 @@ More documentation on Gerrit can be found on the `official website <https://www.
Making Changes
##############
* [Optionnal] Create a ticket in our Tuleap bug tracker https://tuleap.ring.cx/projects/ring
* [Optionnal] Create a ticket in our bug tracker https://git.jami.net
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your commit messages are in the proper format
......
Ring release process
Jami release process
====================
This page explains the process of making a new Ring release. It can be used as checklist of things to remember when making a new release. It was written to clarify the release process between the Ring dev team and the distribution maintainers.
This page explains the process of making a new Jami release. It can be used as checklist of things to remember when making a new release. It was written to clarify the release process between the Jami dev team and the distribution maintainers.
Release tarball
###############
Ring is released in the form of a tarball. They are hosted here:
Jami is released in the form of a tarball. They are hosted here:
- https://dl.ring.cx/ring-release/tarballs/
- https://dl.jami.net/ring-release/tarballs/
Tarballs are generated from the integration branch of the `ring-project <https://github.com/savoirfairelinux/ring-project>`_ repository with a job on our `Jenkins server <https://test.savoirfairelinux.com/>`_. They include a copy of all contrib libraries configured in ``daemon/contrib/src``. If you are a Savoir-faire Linux employee, you may trigger the job from `this page <https://test.savoirfairelinux.com/job/ring-release/>`_.
......@@ -40,14 +40,9 @@ The packaging is maintained using git-buildpackage and can be found in the follo
- git.debian.org:/git/pkg-voip/ring.git
The repository contains a Debian.README file explaining the process of importing a new version. To upload a new version of Ring, manual action is required by Alexandre. If he is unavailable, other members of the Debian VoIP team may do the upload.
The repository contains a Debian.README file explaining the process of importing a new version. To upload a new version of Jami, manual action is required by Alexandre. If he is unavailable, other members of the Debian VoIP team may do the upload.
Upstream packaging
------------------
The Ring dev team builds packages for popular Linux distributions. Those packages are built weekly. Instructions on installing the repositories can be found on `ring.cx/download <https://ring.cx/en/download>`_.
Stable releases
###############
At this moment Ring is still considered in beta and does not support stable releases. This may or may not change when the beta period is over. The most secure and stable version of ring is the tip of the master branch.
The Jami dev team builds packages for popular Linux distributions. Those packages are built weekly. Instructions on installing the repositories can be found on `jami.net/download <https://jami.net/en/download>`_.
......@@ -3,8 +3,8 @@
Downloading and installing
==========================
In order to download and install Ring, first go to Ring’s
`download page <https://ring.cx/en/download>`_ and select the appropriate
In order to download and install Jami, first go to Jami’s
`download page <https://jami.net/en/download>`_ and select the appropriate
platform for your software.
For Gnome/Linux clients
......@@ -13,7 +13,7 @@ For Gnome/Linux clients
Installing via the terminal
---------------------------
To install Ring from the terminal, you just need to follow these next steps:
To install Jami from the terminal, you just need to follow these next steps:
1. Select your Linux distribution (e.g., Debian 8).
2. Copy the commands in the dark box and paste them in a terminal. It’s possible that you need root access for this.
......@@ -22,8 +22,8 @@ To install Ring from the terminal, you just need to follow these next steps:
Installing using binary packages
--------------------------------
If you wish to use an installator and install Ring manually, go to Ring’s
`manual installation <https://ring.cx/en/download/gnu-linux/manual>`_ page and
If you wish to use an installator and install Jami manually, go to Jami’s
`manual installation <https://jami.net/en/download/gnu-linux/manual>`_ page and
follow these steps:
1. Select your Linux distribution from the drop-down list.
......@@ -31,7 +31,7 @@ follow these steps:
3. Download and execute the client installer.
Whether you install Ring via the terminal or binary packages, Ring should have
Whether you install Jami via the terminal or binary packages, Jami should have
been installed on your operating system and should appear in your applications
list.
......
......@@ -123,9 +123,9 @@ function package_rpm()
cat << EOF > ${DISTRIBUTION_REPOSITOIRY_FOLDER}/ring-nightly.repo
[ring]
name=Ring \$releasever - \$basearch - ring
baseurl=https://dl.ring.cx/ring-nightly/fedora_\$releasever
baseurl=https://dl.jami.net/ring-nightly/fedora_\$releasever
gpgcheck=1
gpgkey=https://dl.ring.cx/ring.pub.key
gpgkey=https://dl.jami.net/ring.pub.key
enabled=1
EOF
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment