Refresh some of the information on the codebase docs.

Review Request #6863 — Created Jan. 31, 2015 and submitted

Information

Review Board
master
3c713f6...

Reviewers

This fixes up some of the docs to be a bit more modern and to get rid of
old, misleading information.

The Contributing Patches documentation has been updated to talk about
release branches and pull requests.

URLs have been updated throughout the docs to use HTTPS instead of HTTP
when applicable.

Built the docs. Things looked okay.

Description From Last Updated

Maybe we should mention what the appropriate branch is - like, make it clear that we have a branch that …

mike_conleymike_conley

Would it be worth mentioning clear-pycs here?

mike_conleymike_conley

Is there a place where we could stash the currently maintained major and minor release numbers so that we have …

mike_conleymike_conley
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/custom-forks.rst
        docs/codebase/index.rst
        docs/codebase/contributing-patches.rst
        docs/codebase/unit-tests/fixtures.rst
        docs/codebase/getting-started.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/codebase/custom-forks.rst
        docs/codebase/index.rst
        docs/codebase/contributing-patches.rst
        docs/codebase/unit-tests/fixtures.rst
        docs/codebase/getting-started.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
mike_conley
  1. 
      
  2. docs/codebase/contributing-patches.rst (Diff revision 1)
     
     
     
    Show all issues

    Maybe we should mention what the appropriate branch is - like, make it clear that we have a branch that tracks the current release that's named release-[major]-[minor]-x.

  3. docs/codebase/getting-started.rst (Diff revision 1)
     
     
    Show all issues

    Would it be worth mentioning clear-pycs here?

    1. Probably not here. Might be better as another change, since we likely want a new section for this.

  4. docs/codebase/getting-started.rst (Diff revision 1)
     
     
    Show all issues

    Is there a place where we could stash the currently maintained major and minor release numbers so that we have a central place of truth for these numbers instead of having to update these periodically?

    1. I think it'd require writing a new extension to Sphinx. Not a bad idea, but too big for this change :)

  5. 
      
chipx86
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/codebase/custom-forks.rst
        docs/codebase/index.rst
        docs/codebase/contributing-patches.rst
        docs/codebase/unit-tests/fixtures.rst
        docs/codebase/getting-started.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/codebase/custom-forks.rst
        docs/codebase/index.rst
        docs/codebase/contributing-patches.rst
        docs/codebase/unit-tests/fixtures.rst
        docs/codebase/getting-started.rst
    
    
  2. 
      
mike_conley
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to master (f0738b8)
david
  1. Ship It!
  2.