Skip to content

Commit

Permalink
Renames all doc references from Savanna to Sahara
Browse files Browse the repository at this point in the history
Change-Id: I5249a5a9fcf5ac80c16ef9dfb8c50dcfbfd6f8b8
Implements: blueprint savanna-renaming-docs
  • Loading branch information
bergenholtz committed Mar 17, 2014
1 parent 34f7aea commit eafc150
Show file tree
Hide file tree
Showing 35 changed files with 404 additions and 404 deletions.
4 changes: 2 additions & 2 deletions doc/source/_templates/sidebarlinks.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h3>Useful Links</h3>
<ul>
<li><a href="https://wiki.openstack.org/wiki/Savanna">Savanna @ OpenStack Wiki</a></li>
<li><a href="https://launchpad.net/savanna">Savanna @ Launchpad</a></li>
<li><a href="https://wiki.openstack.org/wiki/Sahara">Sahara @ OpenStack Wiki</a></li>
<li><a href="https://launchpad.net/sahara">Sahara @ Launchpad</a></li>
</ul>

{% if READTHEDOCS %}
Expand Down
2 changes: 1 addition & 1 deletion doc/source/architecture.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Architecture
============

.. image:: images/savanna-architecture.png
.. image:: images/sahara-architecture.png
:width: 800 px
:scale: 99 %
:align: left
Expand Down
14 changes: 7 additions & 7 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
master_doc = 'index'

# General information about the project.
project = u'Savanna'
copyright = u'2013, OpenStack Foundation'
project = u'Sahara'
copyright = u'2014, OpenStack Foundation'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -122,7 +122,7 @@

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Savanna'
html_title = 'Sahara'

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
Expand Down Expand Up @@ -189,7 +189,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'SavannaDoc'
htmlhelp_basename = 'SaharaDoc'


# -- Options for LaTeX output --------------------------------------------------
Expand Down Expand Up @@ -238,7 +238,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'savanna', u'Savanna',
('index', 'sahara', u'Sahara',
[u'OpenStack Foundation'], 1)
]

Expand All @@ -252,8 +252,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Savanna', u'Savanna',
u'OpenStack Foundation', 'Savanna', 'Savanna',
('index', 'Sahara', u'Sahara',
u'OpenStack Foundation', 'Sahara', 'Sahara',
'Miscellaneous'),
]

Expand Down
38 changes: 19 additions & 19 deletions doc/source/devref/development.environment.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
Setting Up a Development Environment
====================================

This page describes how to point a local running Savanna instance to remote OpenStack.
This page describes how to point a local running Sahara instance to remote OpenStack.
You should be able to debug and test your changes without having to deploy.

Setup Local Environment with Savanna inside DevStack
----------------------------------------------------
Setup Local Environment with Sahara inside DevStack
---------------------------------------------------

The easiest way to have local Savanna environment with DevStack is to include
Savanna component in DevStack.
The easiest way to have local Sahara environment with DevStack is to include
Sahara component in DevStack.

.. toctree::
:maxdepth: 1

devstack

After you install DevStack with Savanna included you can rejoin screen with
``rejoin-stack.sh`` command and switch to ``savanna`` tab. Here you can manage
savanna service as other OpenStack services. Savanna source code is located at
``$DEST/savanna`` which is usually ``/opt/stack/savanna``.
After you install DevStack with Sahara included you can rejoin screen with
``rejoin-stack.sh`` command and switch to ``sahara`` tab. Here you can manage
sahara service as other OpenStack services. Sahara source code is located at
``$DEST/sahara`` which is usually ``/opt/stack/sahara``.

Setup Local Environment with external OpenStack
-----------------------------------------------
Expand Down Expand Up @@ -52,8 +52,8 @@ On Fedora-based distributions (e.g., Fedora/RHEL/CentOS/Scientific Linux):

.. sourcecode:: console

$ git clone git://github.com/openstack/savanna.git
$ cd savanna
$ git clone git://github.com/openstack/sahara.git
$ cd sahara

3. Prepare virtual environment:

Expand All @@ -65,9 +65,9 @@ On Fedora-based distributions (e.g., Fedora/RHEL/CentOS/Scientific Linux):

.. sourcecode:: console

$ cp ./etc/savanna/savanna.conf.sample-basic ./etc/savanna/savanna.conf
$ cp ./etc/sahara/sahara.conf.sample-basic ./etc/sahara/sahara.conf

5. Look through the savanna.conf and change parameters which default values do
5. Look through the sahara.conf and change parameters which default values do
not suite you. Set ``os_auth_host`` to the address of OpenStack keystone.

If you are using Neutron instead of Nova Network add ``use_neutron = True`` to
Expand All @@ -76,23 +76,23 @@ also specify ``use_namespaces = True``.

.. note::

Config file can be specified for ``savanna-api`` command using ``--config-file`` flag.
Config file can be specified for ``sahara-api`` command using ``--config-file`` flag.

6. Create database schema:

.. sourcecode:: console

$ tox -evenv -- savanna-db-manage --config-file etc/savanna/savanna.conf upgrade head
$ tox -evenv -- sahara-db-manage --config-file etc/sahara/sahara.conf upgrade head

7. To start Savanna call:
7. To start Sahara call:

.. sourcecode:: console

$ tox -evenv -- savanna-api --config-file etc/savanna/savanna.conf -d
$ tox -evenv -- sahara-api --config-file etc/sahara/sahara.conf -d


Setup local OpenStack dashboard with Savanna plugin
---------------------------------------------------
Setup local OpenStack dashboard with Sahara plugin
--------------------------------------------------

.. toctree::
:maxdepth: 1
Expand Down
20 changes: 10 additions & 10 deletions doc/source/devref/development.guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Development Guidelines
Coding Guidelines
-----------------

For all the code in Savanna we have a rule - it should pass `PEP 8`_.
For all the code in Sahara we have a rule - it should pass `PEP 8`_.

To check your code against PEP 8 run:

Expand All @@ -14,22 +14,22 @@ To check your code against PEP 8 run:

.. note::
For more details on coding guidelines see file ``HACKING.rst`` in the root
of Savanna repo.
of Sahara repo.


Testing Guidelines
------------------

Savanna has a suite of tests that are run on all submitted code,
Sahara has a suite of tests that are run on all submitted code,
and it is recommended that developers execute the tests themselves to
catch regressions early. Developers are also expected to keep the
test suite up-to-date with any submitted code changes.

Unit tests are located at ``savanna/tests``.
Unit tests are located at ``sahara/tests``.

Savanna's suite of unit tests can be executed in an isolated environment
Sahara's suite of unit tests can be executed in an isolated environment
with `Tox`_. To execute the unit tests run the following from the root of
Savanna repo:
Sahara repo:

.. sourcecode:: console

Expand All @@ -39,9 +39,9 @@ Savanna repo:
Documentation Guidelines
------------------------

All Savanna docs are written using Sphinx / RST and located in the main repo
All Sahara docs are written using Sphinx / RST and located in the main repo
in ``doc`` directory. You can add/edit pages here to update
https://savanna.readthedocs.org/en/latest/ site.
http://docs.openstack.org/developer/sahara site.

The documentation in docstrings should follow the `PEP 257`_ conventions
(as mentioned in the `PEP 8`_ guidelines).
Expand Down Expand Up @@ -74,7 +74,7 @@ To make docs generation process faster you can use:

$ SPHINX_DEBUG=1 tox -e docs

or to avoid savanna reinstallation to virtual env each time you want to rebuild
or to avoid sahara reinstallation to virtual env each time you want to rebuild
docs you can use the following command (it could be executed only after
running ``tox -e docs`` first time):

Expand All @@ -86,7 +86,7 @@ running ``tox -e docs`` first time):

.. note::
For more details on documentation guidelines see file HACKING.rst in the root
of Savanna repo.
of Sahara repo.


.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
Expand Down
8 changes: 4 additions & 4 deletions doc/source/devref/devstack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Now we are going to install DevStack in VM we just created. So, connect to VM wi
# But only use the top end of the network by using a /27 and starting at the 224 octet.
FLOATING_RANGE=192.168.55.224/27

# Enable auto assignment of floating IPs. By default Savanna expects this setting to be enabled
# Enable auto assignment of floating IPs. By default Sahara expects this setting to be enabled
EXTRA_OPTS=(auto_assign_floating_ip=True)

# Enable logging
Expand All @@ -97,12 +97,12 @@ Now we are going to install DevStack in VM we just created. So, connect to VM wi
# access to install prerequisites and fetch repositories.
# OFFLINE=True

3. If you would like to have Savanna included into devstack add the following lines to ``localrc``:
3. If you would like to have Sahara included into devstack add the following lines to ``localrc``:

.. sourcecode:: bash

# Enable Savanna
ENABLED_SERVICES+=,savanna
# Enable Sahara
ENABLED_SERVICES+=,sahara

4. Start DevStack:

Expand Down
6 changes: 3 additions & 3 deletions doc/source/devref/gerrit.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Code Reviews with Gerrit
========================

Savanna uses the `Gerrit`_ tool to review proposed code changes. The review site
Sahara uses the `Gerrit`_ tool to review proposed code changes. The review site
is http://review.openstack.org.

Gerrit is a complete replacement for Github pull requests. `All Github pull
requests to the Savanna repository will be ignored`.
requests to the Sahara repository will be ignored`.

See `Gerrit Workflow Quick Reference`_ for information about how to get
started using Gerrit. See `Gerrit, Jenkins and Github`_ for more detailed
documentation on how to work with Gerrit.

.. _Gerrit: http://code.google.com/p/gerrit
.. _Gerrit, Jenkins and Github: http://wiki.openstack.org/GerritJenkinsGithub
.. _Gerrit Workflow Quick Reference: http://wiki.openstack.org/GerritWorkflow
.. _Gerrit Workflow Quick Reference: http://wiki.openstack.org/GerritWorkflow
16 changes: 8 additions & 8 deletions doc/source/devref/how_to_participate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ How to Participate
Getting started
---------------

* Create account on `Github <https://github.com/openstack/savanna>`_
* Create account on `Github <https://github.com/openstack/sahara>`_
(if you don't have one)

* Make sure that your local git is properly configured by executing
``git config --list``. If not, configure ``user.name``, ``user.email``

* Create account on `Launchpad <https://launchpad.net/savanna>`_
* Create account on `Launchpad <https://launchpad.net/sahara>`_
(if you don't have one)

* Subscribe to `OpenStack general mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack>`_
Expand All @@ -28,19 +28,19 @@ Getting started
* Subscribe to code-reviews. Go to your settings on http://review.openstack.org

* Go to ``watched projects``
* Add ``openstack/savanna``, ``openstack/savanna-dashboard``,
``openstack/savanna-extra``, ``openstack/python-savannaclient``,
``openstack/savanna-image-elements``
* Add ``openstack/sahara``, ``openstack/sahara-dashboard``,
``openstack/sahara-extra``, ``openstack/python-saharaclient``,
``openstack/sahara-image-elements``


How to stay in touch with the community?
----------------------------------------

* If you have something to discuss use
`OpenStack development mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_.
Prefix mail subject with ``[Savanna]``
Prefix mail subject with ``[Sahara]``

* Join ``#savanna`` IRC channel on `freenode <http://freenode.net/>`_
* Join ``#sahara`` IRC channel on `freenode <http://freenode.net/>`_

* Join public weekly meetings on *Thursdays at 18:00 UTC* on
``#openstack-meeting-alt`` IRC channel
Expand All @@ -49,7 +49,7 @@ How to stay in touch with the community?
How to send your first patch on review?
---------------------------------------

* Checkout Savanna code from `Github <https://github.com/openstack/savanna>`_
* Checkout Sahara code from `Github <https://github.com/openstack/sahara>`_

* Carefully read https://wiki.openstack.org/wiki/Gerrit_Workflow

Expand Down
4 changes: 2 additions & 2 deletions doc/source/devref/jenkins.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Continuous Integration with Jenkins
===================================

Each change made to Savanna core code is tested with unit and integration tests and style checks flake8.
Each change made to Sahara core code is tested with unit and integration tests and style checks flake8.

Unit tests and style checks are performed on public `OpenStack Jenkins <https://jenkins.openstack.org/>`_ managed by `Zuul <http://status.openstack.org/zuul/>`_.
Unit tests are checked using both python 2.6 and python 2.7.
Expand All @@ -14,4 +14,4 @@ Also a test job is launched on a created Cluster to verify Hadoop work.
All integration tests are launched by `Jenkins <http://jenkins.savanna.mirantis.com/>`_ on internal Mirantis OpenStack Lab.
Jenkins keeps a pool of VMs to run tests in parallel. Still integration testing may take a while.

The integration tests result is +1 or -1 to *Verify* column in a code review from *savanna-ci* user.
The integration tests result is +1 or -1 to *Verify* column in a code review from *savanna-ci* user.
26 changes: 13 additions & 13 deletions doc/source/devref/launchpad.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Project hosting with Launchpad
==============================

`Launchpad`_ hosts the Savanna project. The Savanna project homepage on Launchpad is
http://launchpad.net/savanna.
`Launchpad`_ hosts the Sahara project. The Sahara project homepage on Launchpad is
http://launchpad.net/sahara.

Launchpad credentials
---------------------
Expand All @@ -18,31 +18,31 @@ OpenStack-related sites. These sites include:
Mailing list
------------

The mailing list email is ``savanna[email protected]``. To participate in the mailing list:
The mailing list email is ``sahara[email protected]``. To participate in the mailing list:

#. Join the `Savanna Team`_ on Launchpad.
#. Subscribe to the list on the `Savanna Team`_ page on Launchpad.
#. Join the `Sahara Team`_ on Launchpad.
#. Subscribe to the list on the `Sahara Team`_ page on Launchpad.

The mailing list archives are at https://lists.launchpad.net/savanna-all
The mailing list archives are at https://lists.launchpad.net/sahara-all


Bug tracking
------------

Report Savanna bugs at https://bugs.launchpad.net/savanna
Report Sahara bugs at https://bugs.launchpad.net/sahara

Feature requests (Blueprints)
-----------------------------

Savanna uses Launchpad Blueprints to track feature requests. Blueprints are at
https://blueprints.launchpad.net/savanna.
Sahara uses Launchpad Blueprints to track feature requests. Blueprints are at
https://blueprints.launchpad.net/sahara.

Technical support (Answers)
---------------------------

Savanna uses Launchpad Answers to track Savanna technical support questions. The Savanna
Answers page is at https://answers.launchpad.net/savanna
Sahara uses Launchpad Answers to track Sahara technical support questions. The Sahara
Answers page is at https://answers.launchpad.net/sahara

.. _Launchpad: http://launchpad.net
.. _Wiki: http://wiki.openstack.org/savanna
.. _Savanna Team: https://launchpad.net/~savanna-all
.. _Wiki: http://wiki.openstack.org/sahara
.. _Sahara Team: https://launchpad.net/~sahara-all
Loading

0 comments on commit eafc150

Please sign in to comment.