openstack/nova
Code Issues Proposed changes

Updated RST docs: bzr/launchpad -> git/github

Browse Source 
Change-Id: I3534cc380cb9170ff96f710250b470dc284e5680
This commit is contained in:
Lorin Hochstein 2011-10-17 16:01:28 -04:00
parent 821fae95d6
commit 1d5fd3d98c
4 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/community.rst
View File

@ -56,13 +56,18 @@ to write drafts for specs or documentation, describe a blueprint, or collaborate
`OpenStack Wiki <http://wiki.openstack.org/>`_
Nova on Github
--------------
Github is a code hosting service that hosts the Nova source code.
* `Github Nova page <http://github.com/openstack/nova>`_
Nova on Launchpad
-----------------
Launchpad is a code hosting service that hosts the Nova source code. From
Launchpad you can report bugs, ask questions, and register blueprints (feature requests).
From Launchpad you can report bugs, ask questions, and register blueprints (feature requests).
* `Learn about how to use bzr with launchpad <http://wiki.openstack.org/LifeWithBzrAndLaunchpad>`_
* `Launchpad Nova Page <http://launchpad.net/nova>`_
OpenStack Blog
@ -90,6 +95,6 @@ OpenStack Docs Site
The `nova.openstack.org <http://nova.openstack.org>`_ site is geared towards developer documentation,
and the `docs.openstack.org <http://docs.openstack.org>`_ site is intended for cloud administrators
who are standing up and running OpenStack Compute in production. You can contribute to the Docs Site
by using bzr and Launchpad and contributing to the openstack-manuals project at http://launchpad.net/openstack-manuals.
by using git and Gerrit and contributing to the openstack-manuals project at http://github.com/openstack/openstack-manuals.

16
doc/source/devref/development.environment.rst
View File

@ -18,14 +18,14 @@
Setting Up a Development Environment
====================================
This page describes how to setup a working Python development environment that can be used in developing on OpenStack on Ubuntu or Mac OSX. These instructions assume you're already familiar with bzr and can pull down the code with an existing Launchpad account. Refer to http://wiki.openstack.org/LifeWithBzrAndLaunchpad for additional information.
This page describes how to setup a working Python development environment that can be used in developing on OpenStack on Ubuntu or Mac OSX. These instructions assume you're already familiar with git. Refer to http://wiki.openstack.org/GettingTheCode for additional information.
Linux Systems
-------------
Note: This section is tested for Nova on Ubuntu 10.10-64. Feel free to add notes and change according to your experiences or operating system.
Bring down the Nova source with bzr, then:
Bring down the Nova source with git, then:
::
cd <your_src_dir>/nova
sudo apt-get install python-dev swig libssl-dev python-pip
@ -72,7 +72,7 @@ First, install Virtual Env, which creates an isolated "standalone" Python enviro
Here's how to setup the code initially::
bzr branch lp:nova
git clone https://github.com/openstack/nova.git
cd nova
python tools/install_venv.py
source .nova_venv/bin/activate
@ -84,7 +84,7 @@ If you have installed OpenSSL 1.0.0a on MacOS, which can happen when installing
Here's how to get the latest code::
cd nova
bzr pull # get the latest stuff...
git pull # get the latest stuff...
source .nova_venv/bin/activate
./run_tests.sh
@ -93,10 +93,4 @@ Then you can do cleaning work or hack hack hack with a branched named cleaning.
Contributing Your Work
----------------------
Once your work is complete you may wish to contribute it to the project. Add your name and email address to the `Authors` file, and also to the `.mailmap` file if you use multiple email addresses. Your contributions can not be merged into trunk unless you are listed in the Authors file. Now, push the branch to Launchpad::
bzr push lp:~launchpaduserid/nova/cleaning
To submit the merge/patch that you hacked upon:
* Navigate to https://code.launchpad.net/~launchpaduserid/nova/cleaning.
* Click on the link "Propose for merging".
Once your work is complete you may wish to contribute it to the project. Add your name and email address to the `Authors` file, and also to the `.mailmap` file if you use multiple email addresses. Your contributions can not be merged into trunk unless you are listed in the Authors file. Nova uses the Gerrit code review system. For information on how to submit your branch to Gerrit, see http://wiki.openstack.org/GerritWorkflow

1
doc/source/nova.concepts.rst
View File

@ -57,6 +57,7 @@ Concept: Virtualization
* XEN
* HyperV
* qemu
* LXC
Concept: Instances

9
doc/source/quickstart.rst
View File

@ -43,11 +43,14 @@ Nova is hosted on launchpad. You can get the code with the following command
::
bzr clone lp:nova
git clone https://github.com/openstack/nova.git
The `contrib/nova.sh` file in the source distribution is a script that
will quickly set up nova to run on a single machine. It is tested against
Ubuntu only, but other distributions are forthcoming.
Ubuntu only, but other distributions are forthcoming.
A more recent shell script for setting up an OpenStack development environment
can be found at http://devstack.org
Environment Variables
---------------------
@ -152,7 +155,7 @@ virsh instances and attempt to delete all vlans and bridges.
./nova.sh scrub
You can edit files in the install directory or do a bzr pull to pick up new versions. You only need to do
You can edit files in the install directory or do a git pull to pick up new versions. You only need to do
::