features-on-develop-branch

[jseldess]

This PR covers how to get access to features on develop but not yet included in any official beta binary.

• install-cockroachdb.md: Updated the build from source install instructions to mention building from code on the develop branch.
• _includes/develop-paragraph.md and _includes/develop-callout.html: Added reusable disclaimers to be used in docs for any feature only on develop.
• develop-branch.md: Added a page where we can list features available only on the develop branch. Ideally, we'll link to the docs for the feature and list the date on which the feature was merged.

@spencerkimball, @petermattis, @bdarnell, PTAL. Ben mentioned in chat that his preference would be to leave the install docs focused on the latest beta version and use contributing.md to focus on develop. At that point, these changes were pretty much done, so I've decided to discuss here. Thoughts?

Fixes #548

---

This change is

[jseldess]

HTML version here: http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/0e410756c1dd4fe6c4253ede1fcf12e48be17313/

In particular, see:

• http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/0e410756c1dd4fe6c4253ede1fcf12e48be17313/install-cockroachdb.html (click Build from Source)
• http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/0e410756c1dd4fe6c4253ede1fcf12e48be17313/develop-branch.html

[RaduBerinde]

The build from source page doesn't say how to get the latest features we link to - one would need to do git checkout develop for that no?

---

Review status: 0 of 4 files reviewed at latest revision, all discussions resolved.

---

Comments from Reviewable

[jseldess]

@RaduBerinde, if you're doing this for the first time, go get -d github.com/cockroachdb/cockroach puts you on develop by default, based on my testing. But if you've built from source before, I think master remains the default and so you would have to checkout develop. Does that sound right?

[RaduBerinde]

Ah, I didn't realize go get now gets the develop branch. In that case,

---

Review status: 0 of 4 files reviewed at latest revision, 1 unresolved discussion.

---

install-cockroachdb.md, line 208 [r1] (raw file):

    <p>The first time you run <code class="highlighter-rouge">make install</code>, it can take awhile to download and install various dependencies.</p>

    <div class="bs-callout bs-callout-success">This step builds a binary that includes features not yet in an official beta release. To build the latest beta version instead, run <code>git checkout {{site.data.strings.version}}</code> before <code>make install</code>.</div>

Let's mention the develop branch here - maybe "this step builds a binary from the develop branch, which includes features not yet .."

---

Comments from Reviewable

[sploiselle]

This is great. Really impressed you put together so quickly!

---

Review status: 0 of 4 files reviewed at latest revision, 1 unresolved discussion.

---

Comments from Reviewable

[bdarnell]

LGTM, although I'd prefer the build-from-source instructions to default to the latest beta tag and present the develop branch as an option.

---

Review status: 0 of 4 files reviewed at latest revision, 1 unresolved discussion.

---

Comments from Reviewable

[jseldess]

@RaduBerinde, I made the reference to develop more explicit. @bdarnell, I went with your suggestion; the instructions build the latest binary by default, and there's a note about how to build from the develop branch instead.

---

Review status: 0 of 4 files reviewed at latest revision, 1 unresolved discussion.

---

install-cockroachdb.md, line 208 [r1] (raw file):

Previously, RaduBerinde wrote…

Let's mention the develop branch here - maybe "this step builds a binary from the develop branch, which includes features not yet .."

Done.

---

Comments from Reviewable

[RaduBerinde]

---

Review status: 0 of 4 files reviewed at latest revision, all discussions resolved.

---

Comments from Reviewable

[jseldess]

Thanks, all. I'll wait until we've documented a new feature on develop before merging and publishing this change.