Refresh some of the information on the codebase docs.
Review Request #6863 — Created Jan. 31, 2015 and submitted
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_conley
|
|
|
Would it be worth mentioning clear-pycs here? |
mike_conley
|
|
|
Is there a place where we could stash the currently maintained major and minor release numbers so that we have … |
mike_conley
|
-
-
docs/codebase/contributing-patches.rst (Diff revision 1) 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.
-
-
docs/codebase/getting-started.rst (Diff revision 1) 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?
Change Summary:
Added some more details on the branch naming.
Branch: |
|
||||
|---|---|---|---|---|---|
Commit: |
|
||||
Diff: |
Revision 2 (+40 -43) |
-
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
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