Add documentation on configuring specific types of repositories.
Review Request #8537 — Created Nov. 14, 2016 and submitted
This adds documentation on configuring Bazaar, ClearCase, CVS, Git, Mercurial, Perforce, and Subversion repositories. It goes into the various setup options for each type and provides a complete walkthrough on how to get set up, from installing dependencies to configuring fields to the various authentication and conncetion options (where appropriate). This replaces the old and very basic documentation we had before. These docs do not cover setting up hosting services yet. That will be done separately.
Built the docs and read through. Checked links and setup instructions
for accuracy.
| Description | From | Last Updated |
|---|---|---|
|
This is kind of an abrupt transition. Can we add some more info about what the limited remote protocol means … |
 david
|
|
|
Should be "Perforce" |
david
|
|
|
Fix wrapping? |
david
|
|
|
Too many spaces between sentences. |
david
|
|
|
Fix wrapping? |
david
|
|
|
Should be Subversion, not Git. |
 gmyers
|
|
|
typo: requess |
david
|
|
|
requess |
david
|
|
|
requess |
david
|
|
|
requess |
david
|
|
|
requess |
david
|
|
|
I think we should probably list these at the top rather than the bottom. I think it's likely that someone … |
david
|
|
|
These should probably be listed near the top rather than the bottom. |
david
|
|
|
Should mention these near the top. |
david
|
Change Summary:
Added some notes on requiring local/network access to repositories or using hosting services to more of the doc pages.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+965 -199) |
-
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst
-
-
docs/manual/admin/configuration/repositories/subversion.rst (Diff revision 2) Should be Subversion, not Git.
-
-
docs/manual/admin/configuration/repositories/git.rst (Diff revision 2) This is kind of an abrupt transition. Can we add some more info about what the limited remote protocol means for users (i.e. that they'll have to set up some kind of frontend server or use a local path)?
-
-
-
docs/manual/admin/configuration/repositories/perforce.rst (Diff revision 2) Too many spaces between sentences.
-
Change Summary:
- Fixed wrapping and spacing issues.
- Expanded a paragraph in Git so as to not end so abruptly.
- Fixed some copy/paste issues with SCM names.
- Changed all reference names for SCM-specific docs to have a
repository-scm-prefix, instead ofrepository-. - Changed all doc names to say "<SCM> Repositories" instead of "Adding <SCM> Repositories".
- Changed guilabels to use sentence casing instead of title casing where appropriate.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 3 (+978 -199) |
-
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst
Change Summary:
Fixed a copy-and-pasted typo.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 4 (+978 -199) |
-
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst
-
-
docs/manual/admin/configuration/repositories/git.rst (Diff revision 4) I think we should probably list these at the top rather than the bottom. I think it's likely that someone who has a git repository hosted on GitHub might end up here, and get confused/annoyed at the instructions for GitWeb, etc.
-
docs/manual/admin/configuration/repositories/mercurial.rst (Diff revision 4) These should probably be listed near the top rather than the bottom.
-
docs/manual/admin/configuration/repositories/subversion.rst (Diff revision 4) Should mention these near the top.
Change Summary:
Moved references to hosting service docs to the main section of each repository doc page, inside a big note field.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 5 (+906 -199) |
-
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/admin/configuration/index.rst docs/manual/admin/configuration/repositories/mercurial.rst docs/manual/admin/configuration/repositories/git.rst docs/manual/admin/configuration/repositories/index.rst docs/manual/admin/configuration/repositories/subversion.rst docs/manual/admin/index.rst docs/manual/admin/installation/linux.rst docs/manual/admin/configuration/repositories/bazaar.rst docs/manual/users/review-requests/creating.rst docs/manual/admin/configuration/repositories/clearcase.rst docs/manual/admin/configuration/repositories/perforce.rst docs/manual/admin/configuration/repositories/cvs.rst