Documentation/HowTo/FirstTimers
< Documentation | HowTo
Revision as of 14:38, 10 December 2013 by Annegentle (talk | contribs) (Adds first time doc tasks ideas and workflow walkthrough)
For OpenStack documentation, one of the best places to start is by walking through the install guide and completing it by hand.
Signup tutorial:
- Create an account in Launchpad at https://login.launchpad.net/+new_account
- Log in to your Launchpad account
- Generate SSH key:�ssh-keygen –t rsa�
- View and copy SSH key: less ~/.ssh/id_rsa.pub
- Add SSH key to Launchpad (click your name in upper right hand corner, then click ! Next to SSH keys)
- Go to http://openstack.org/join, fill out forms
- Go to http://review.openstack.org/, click Sign In, use your Launchpad account credentials
- Install git. https://help.github.com/articles/set-up-git
- If this is your first time setting up git, be sure to run these steps:
- $ git config --global user.name "Firstname Lastname"
- $ git config --global user.email name@youremail.com
- Clone a repository: $ git clone git://git.openstack.org/openstack/glance.git
- Install git-review so you can submit patches: $ sudo pip install git-review �or $sudo apt-get install git-review
- Test to ensure you can connect: $ git review –s
- Create a new remote with this command: $ git remote add gerrit ssh://<username>@review.openstack.org:29418/openstack/openstack-manuals.git
- Switch to the repository and checkout: $ git checkout master; git remote update; git pull origin master
- Assign a bug to yourself. https://bugs.launchpad.net/glance/+bug/1112670
- Fix it, then commit and patch: $ git checkout –b fix-bug-1112670
- Create a patch for review.openstack.org with: $ git review -v
- Copy and paste the URL returned from git review to take a look: http://review.openstack.org/nnnnnn
- Celebrate and wait for reviews
Review tutorial:
- Get the six-digit patch number from review.openstack.org, copy it
- At the command line, change to the directory where the repo is stored
- Enter: git review -d nnnnnn (where nnnnnn is pasted from the review.openstack.org URL)
- Make your edits
- In the directory where the repo is stored: $ git commit -a --amend
- Then push to review.openstack.org again: $ git review -v
- Wait for more reviews