Skip to content

Commit bccebc5

Browse files
author
Jesse Seldess
committed
features-on-develop-branch
1 parent 902c67f commit bccebc5

File tree

4 files changed

+25
-5
lines changed

4 files changed

+25
-5
lines changed

_data/sidebar_doc.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,5 +310,8 @@ entries:
310310
- title: beta-20160629
311311
url: /beta-20160629.html
312312

313-
- title: Older Versions
313+
- title: Older Beta Versions
314314
url: /older-versions.html
315+
316+
- title: Features on Develop Branch
317+
url: /develop-branch.html

_includes/develop.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{site.data.alerts.callout_info}}This feature is available only when you <a href="install-cockroachdb.html">build a CockroachDB binary</a> from the code on our <code>develop</code> branch. For a list of other features available only when building from source, see <a href="develop-branch.html">Features on the Develop Branch</a>.{{site.data.alerts.end}}

develop-branch.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: New Features on Develop Branch
3+
toc: false
4+
---
5+
6+
These features are available only when you <a href="install-cockroachdb.html">build a CockroachDB binary</a> from the code on our <code>develop</code> branch. They are not yet included in an official beta release.
7+
8+
Feature | Merge Date
9+
--------|-----------
10+
xxx | xxx
11+

install-cockroachdb.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ $(document).ready(function(){
7777
</div>
7878

7979
<div id="macinstall">
80-
<p>There are four ways to install CockroachDB on Mac OS X. See <a href="{{site.data.strings.version}}.html">Release Notes</a> for what's new in the latest version.</p>
80+
<p>There are four ways to install CockroachDB on Mac OS X. See <a href="{{site.data.strings.version}}.html">Release Notes</a> for what's new in the latest version. </p>
8181

8282
<div id="mac-installs" class="clearfix">
8383
<a href="#download-the-binary" class="install-button mac-button current" data-eventcategory="buttonClick-doc-install" data-eventaction="mac-binary">Download the <div class="c2a">Binary</div></a>
@@ -172,6 +172,7 @@ $(document).ready(function(){
172172

173173
<div id="build-from-source" class="install-option" style="display: none;">
174174
<h2>Build from Source</h2>
175+
<div class="bs-callout bs-callout-info">Unlike the other install methods, building from source gets you access to the <a href="develop-branch.html">latest features</a> not yet included in an official beta release.</div>
175176
<ol>
176177
<li>
177178
<p>Install the following prerequisites, as necessary:</p>
@@ -200,9 +201,11 @@ $(document).ready(function(){
200201
<li>
201202
<p>Compile the CockroachDB binary:</p>
202203

203-
<div class="highlighter-rouge"><pre class="highlight"><code data-eventcategory="mac-source-step3"><span class="gp" data-eventcategory="mac-source-step3">$ </span><span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/github.com/cockroachdb/cockroach<br><span class="gp" data-eventcategory="mac-source-step3">$ </span>git checkout {{site.data.strings.version}}<br><span class="gp">$ </span>make install</code></pre></div>
204+
<div class="highlighter-rouge"><pre class="highlight"><code data-eventcategory="mac-source-step3"><span class="gp" data-eventcategory="mac-source-step3">$ </span><span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/github.com/cockroachdb/cockroach<br><span class="gp">$ </span>make install</code></pre></div>
204205

205206
<p>The first time you run <code class="highlighter-rouge">make install</code>, it can take awhile to download and install various dependencies.</p>
207+
208+
<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>
206209
</li>
207210
<li>
208211
<p>The <code class="highlighter-rouge">make install</code> command puts the binary in <code class="highlighter-rouge"><span class="nv">$GOPATH</span>/bin</code>. Add this directory to your <code class="highlighter-rouge">PATH</code>, if it isn't already there. This makes it easy to execute <a href="cockroach-commands.html">cockroach commands</a> from any shell.</p>
@@ -333,7 +336,7 @@ $(document).ready(function(){
333336

334337
<div id="build-from-source-linux" class="install-option" style="display: none;">
335338
<h2>Build from Source</h2>
336-
339+
<div class="bs-callout bs-callout-info">Unlike the other install methods, building from source gets you access to the <a href="develop-branch.html">latest features</a> not yet included in an official beta release.</div>
337340
<ol>
338341
<li>
339342
<p>Install the following prerequisites, as necessary:</p>
@@ -362,9 +365,11 @@ $(document).ready(function(){
362365
<li>
363366
<p>Compile the CockroachDB binary:</p>
364367

365-
<div class="highlighter-rouge"><pre class="highlight"><code data-eventcategory="linux-source-step3"><span class="gp" data-eventcategory="linux-source-step3">$ </span><span class="nb" data-eventcategory="linux-source-step3">cd</span> <span class="nv" data-eventcategory="linux-source-step3">$GOPATH</span>/src/github.com/cockroachdb/cockroach<br><span class="gp" data-eventcategory="linux-source-step3">$ </span>git checkout {{site.data.strings.version}}<br><span class="gp">$ </span>make install</code></pre></div>
368+
<div class="highlighter-rouge"><pre class="highlight"><code data-eventcategory="linux-source-step3"><span class="gp" data-eventcategory="linux-source-step3">$ </span><span class="nb" data-eventcategory="linux-source-step3">cd</span> <span class="nv" data-eventcategory="linux-source-step3">$GOPATH</span>/src/github.com/cockroachdb/cockroach<br><span class="gp">$ </span>make install</code></pre></div>
366369

367370
<p>The first time you run <code class="highlighter-rouge">make install</code>, it can take awhile to download and install various dependencies.</p>
371+
372+
<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>
368373
</li>
369374
<li>
370375
<p>The <code class="highlighter-rouge">make install</code> command puts the binary in <code class="highlighter-rouge"><span class="nv">$GOPATH</span>/bin</code>. Add this directory to your <code class="highlighter-rouge">PATH</code>, if it isn't already there. This makes it easy to execute <a href="cockroach-commands.html">cockroach commands</a> from any shell.</p>

0 commit comments

Comments
 (0)