|
|
| (163 intermediate revisions by 13 users not shown) |
| Line 1: |
Line 1: |
| − | For OpenStack documentation, one of the best places to start is by walking through the install guide and completing it by hand. You can complete a 2-node install with two VMs, for example. Keep notes as you go, offering suggestions for improvement.
| + | Read the new content in the [http://docs.openstack.org/contributor-guide/quickstart/first-timers.html Documentation Contributor Guide]. |
| | + | {{OpenStack_Documentation_Navbar}} |
| | | | |
| − | Another good first-time docs task is to go to the bugs list at https://bugs.launchpad.net/openstack-manuals/+bugs and look at the new bugs. When you see a doc bug you know how to fix, comment in the bug how to fix the bug. Mark it "Triaged" and give it a status based on [[Documentation/HowTo#Doc_Bug_Triaging_Guidelines]]. If you're up for it, you can assign yourself the bug.
| + | ---- |
| − | | + | [[Category:Documentation]] |
| − | Here's a step-by-step 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, don't forget to [https://help.github.com/articles/generating-ssh-keys add your SSH key (the same one generated before) to GitHub], and 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/openstack-manuals.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/openstack-manuals/+bug/1252931
| |
| − | # Create a new local branch: $ git checkout –b fix-bug-1252931
| |
| − | # Fix the bug in the docs, read the guide on "How to contribute to the documentation": https://wiki.openstack.org/wiki/Documentation/HowTo#Policies_and_conventions, pay attention to Policies_and_conventions section which talks about Git commit messages, backports and other conventions.
| |
| − | # Commit the local change: $ git commit -a
| |
| − | # Edit the commit message, following the guidelines documented at https://wiki.openstack.org/wiki/GitCommitMessages
| |
| − | # 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
| |
| − | | |
| − | Once you've submitted a patch, here's a 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
| |
