Update the documentation on getting started with development.

Review Request #7630 — Created Sept. 15, 2015 and submitted

Information

Review Board
release-2.0.x

Reviewers

This updates the documentation to modernize some of the steps, such as
using pip instead of easy_install, and using RBTools and devserver.py
correctly.

The biggest update has to do with the list of dependencies, which no
longer includes the Python modules that will be automatically installed
by prepare-dev.py.

There are also a variety of other small updates for URLs and branch
names.

Built the docs and looked through them.

Description From Last Updated

https:// not shhtp://

gmyersgmyers

I'm a little confused, but the original text doesn't even match the published docs on the website (https://www.reviewboard.org/docs/codebase/dev/getting-started/#rbtools). Actually, this …

gmyersgmyers
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/codebase/index.rst
        docs/codebase/getting-started.rst
        docs/codebase/unit-tests/fixtures.rst
        docs/codebase/custom-forks.rst
        docs/codebase/tasks/database-evolutions.rst
        docs/codebase/contributing-patches.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/index.rst
        docs/codebase/getting-started.rst
        docs/codebase/unit-tests/fixtures.rst
        docs/codebase/custom-forks.rst
        docs/codebase/tasks/database-evolutions.rst
        docs/codebase/contributing-patches.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
gmyers
  1. 
      
  2. docs/codebase/custom-forks.rst (Diff revision 1)
     
     

    https:// not shhtp://

  3. docs/codebase/getting-started.rst (Diff revision 1)
     
     
    I'm a little confused, but the original text doesn't even match the published docs on the website (https://www.reviewboard.org/docs/codebase/dev/getting-started/#rbtools).  Actually, this looks like it is a master vs. release-2.0.x issue?  In any event, "both" in the updated text seems unnecessary.
  4. docs/codebase/index.rst (Diff revision 1)
     
     
    FWIW, this link now redirects to http://cheat.errtheblog.com/s/git.  Perhaps https://training.github.com/kit/downloads/github-git-cheat-sheet.pdf is more representative of the original content?
  5. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (408f3ec)
Loading...