Add a guide for using Git with RBTools.

Review Request #10969 — Created March 25, 2020 and submitted

Information

RBTools
release-1.0.x

Reviewers

This introduces the start of a new "RBTools Workflows" section of
documentation, designed to help people learn how to incorporate RBTools
into their workflow. To start off, we're adding a workflow for Git.

This is an updated version of an old blog post we've often pointed users
to:

https://blog.beanbaginc.com/2015/01/26/an-effective-rbtools-workflow-for-git/

The new version is broken down into individual steps (creating your
branch, posting it, updating, landing your change, and closing your
review request), followed by an example walking users through every
step.

Unlike the blog post, this is able to better link to relevant
documentation and provide general tips here and there.

The intent is to stop linking people to the old (hard to find) blog post
and instead give some canonical documentation on getting going, which
should be very helpful as people get started.

Built the docs. Checked for build errors, spelling errors, and link
errors.

There are a few build warnings due to links that don't yet exist in
the Review Board documentation, but this will be addressed.

Summary ID
Add a guide for using Git with RBTools.
This introduces the start of a new "RBTools Workflows" section of documentation, designed to help people learn how to incorporate RBTools into their workflow. To start off, we're adding a workflow for Git. This is an updated version of an old blog post we've often pointed users to: https://blog.beanbaginc.com/2015/01/26/an-effective-rbtools-workflow-for-git/ The new version is broken down into individual steps (creating your branch, posting it, updating, landing your change, and closing your review request), followed by an example walking users through every step. Unlike the blog post, this is able to better link to relevant documentation and provide general tips here and there. The intent is to stop linking people to the old (hard to find) blog post and instead give some canonical documentation on getting going, which should be very helpful as people get started.
043d7b8e7985523de8276994b93fddec1633cec1
Description From Last Updated

We might want to explain the consequences here (i.e. that it could end up sending a lot more data to …

daviddavid

Perhaps suggest that people commit a .reviewboardrc to their repository that can be different for each branch?

daviddavid

:option: seems wrong

daviddavid
david
  1. 
      
  2. docs/rbtools/workflows/git.rst (Diff revision 1)
     
     
    Show all issues

    We might want to explain the consequences here (i.e. that it could end up sending a lot more data to the server than necessary)

    1. Oh, right, good idea.

  3. docs/rbtools/workflows/git.rst (Diff revision 1)
     
     
    Show all issues

    Perhaps suggest that people commit a .reviewboardrc to their repository that can be different for each branch?

  4. docs/rbtools/workflows/git.rst (Diff revision 1)
     
     
    Show all issues

    :option: seems wrong

    1. Seems wrong, but isn't. This is how you reference a command line program + option.

  5. 
      
chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to release-1.0.x (988c0b8)