Summary

Add a guide for using Git with RBTools.

Review Request #10969 — Created March 25, 2020 and submitted April 2, 2020, 5:42 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-1.0.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

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.

Testing Done

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.

Commits

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

Summary

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

Issues

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 …	david	March 25, 2020, 6 p.m.
Perhaps suggest that people commit a .reviewboardrc to their repository that can be different for each branch?	david	March 25, 2020, 6:13 p.m.
:option: seems wrong	david	March 25, 2020, 4:25 p.m.

flake8 passed.

JSHint passed.

docs/rbtools/workflows/git.rst (Diff revision 1)

The issue has been resolved. 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)

chipx86 March 25, 2020, 4:25 p.m.
```
Oh, right, good idea.
```

docs/rbtools/workflows/git.rst (Diff revision 1)

The issue has been resolved. Show all issues

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

docs/rbtools/workflows/git.rst (Diff revision 1)
The issue has been dropped. Show all issues
```
:option: seems wrong
```
1. chipx86 March 25, 2020, 4:25 p.m.
  Seems wrong, but isn't. This is how you reference a command line program + option.

Change Summary:


Added text explaining what can happen if a tracking branch is not set or not correct.
Added a recommendation to commit a .reviewboardrc file, with some options that should be set.

Commits:

	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.	498f32ae49178d9480e02e676d266d31ea754e0c
	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

Diff:

Revision 2 (+704)

Show changes

	docs/rbtools/index.rst
	docs/rbtools/rbt/configuration/repositories.rst
	docs/rbtools/workflows/git.rst
	docs/rbtools/workflows/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-1.0.x (988c0b8)