docs: responses to doc feedback. clean up install and release instruc…

…tions (#782)

DEVELOPING.md

@@ -36,18 +36,21 @@ We use [goreleaser](https://goreleaser.com) for releases.
 
 Requirements:
 - goreleaser
-- Linux
+- MacOS
 - `GITHUB_TOKEN` env variable with repo scope
 
-Currently releases only work on Linux -> Linux due to cross-compilation issues with Apple FSEvents.
+Currently, releases have to be built on MacOS due to cross-compilation issues with Apple FSEvents.
+Cross-compiling a Linux target binary with a MacOS toolchain works fine.
 
 To create a new release at tag `$TAG`:
 
 ```
-git tag -a v0.0.1 -m "First release"
+git tag -a v0.0.1 -m "my release"
 git push origin v0.0.1
 make release
 ```
 
-goreleaser will build binaries for the latest tag (using semantic version to determine "latest").
+goreleaser will build binaries for the latest tag (using semantic version to
+determine "latest"). Check the current releases to figure out what the latest
+release ought to be.
 

README.md

@@ -36,7 +36,7 @@ to help you `tilt up` quickly.
 Down with YAML!
 
 Configure Tilt with a `Tiltfile`, written in a small subset of Python called
-[Starlark](https://github.com/bazelbuild/starlark#tour>).
+[Starlark](https://github.com/bazelbuild/starlark#tour).
 
 To get started, check out some [examples](https://docs.tilt.build/first_example.html) or dive into the
 [API reference](https://docs.tilt.build/api.html).

docs/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 971ea7522f20fe2fad2d6ed77e848b39
+config: dbb4e42e3dd52aee8a9824ffbab31b36
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/fast_build.md.txt

@@ -1,4 +1,4 @@
-Expanding a Tiltfile
+Optimizing a Tiltfile
 =====================
 
 This tutorial looks at a `Tiltfile` with build optimizations.
@@ -70,9 +70,9 @@ FROM golang:1.10
 
 It's only one line! This line says we're starting in a golang:1.10 container.
 
-This `Dockerfile` looks different than most `Dockerfile`s because
-it cannot contain any `ADD` or `COPY` lines.
+Fast build Dockerfiles cannot contain any ADD or COPY lines.
 It's only for setting up the environment, not for adding your code.
+So this Dockerfile might look different than most.
 
 * `repo = local_git_repo('.')`
 

docs/_build/html/_sources/index.md.txt

@@ -29,15 +29,15 @@ Download the Tilt binary on
 [the github releases page](https://github.com/windmilleng/tilt/releases).
 
 Tilt expects that you already have Docker and `kubectl` installed.
-Read the more detailed [Installation Guide](quickstart.html)
+Read the more detailed [Installation Guide](install.html)
 to help you `tilt up` quickly.
 
 ## Configure Your Workflow to Share With Your Team
 
 Down with YAML!
 
 Configure Tilt with a `Tiltfile`, written in a small subset of Python called
-[Starlark](https://github.com/bazelbuild/starlark#tour>).
+[Starlark](https://github.com/bazelbuild/starlark#tour).
 
 To get started, check out some [examples](first_example.html) or dive into the
 [API reference](api.html).
@@ -48,7 +48,7 @@ To get started, check out some [examples](first_example.html) or dive into the
 .. toctree::
    :maxdepth: 1
 
-   quickstart
+   install
    first_example
    first_config
    fast_build

docs/_build/html/_sources/quickstart.md.txt → docs/_build/html/_sources/install.md.txt

@@ -26,10 +26,8 @@ $ kubectl config use-context docker-for-desktop
 - Install the Tilt binary with:
 
 ```
-$ wget https://github.com/windmilleng/tilt/releases/download/v0.1.0/tilt.0.1.0.mac.x86_64.tar.gz && \
-    mkdir tilt && \
-    tar -C tilt -xzvf tilt.0.1.0.mac.x86_64.tar.gz && \
-    sudo mv tilt/tilt /usr/local/bin/tilt
+$ curl -L https://github.com/windmilleng/tilt/releases/download/v0.1.0/tilt.0.1.0.mac.x86_64.tar.gz | tar -xzv tilt && \
+  sudo mv tilt /usr/local/bin/tilt
 ```
 
 - Verify that you installed it correctly with:
@@ -64,10 +62,8 @@ $ kubectl cluster-info
 - Install the Tilt binary with:
 
 ```
-$ wget https://github.com/windmilleng/tilt/releases/download/v0.1.0/tilt.0.1.0.linux.x86_64.tar.gz && \
-    mkdir tilt && \
-    tar -C tilt -xzvf tilt.0.1.0.linux.x86_64.tar.gz && \
-    sudo mv tilt/tilt /usr/local/bin/tilt
+$ curl -L https://github.com/windmilleng/tilt/releases/download/v0.1.0/tilt.0.1.0.linux.x86_64.tar.gz | tar -xzv tilt && \
+    sudo mv tilt /usr/local/bin/tilt
 ```
 
 - Verify that you installed it correctly with:

docs/_build/html/_sources/upgrade_skaffold.md.txt

@@ -1,10 +1,10 @@
 # From Skaffold
 ## Before you begin
-* [Install Tilt](quickstart.html)
+* [Install Tilt](install.html)
 * If you're new to Tilt try stepping through [a Simple Tiltfile](first_config.html) first.
 
 ## Differences between Skaffold and Tilt
-* Skaffold streams the logs for services it started. Tilt provides a UI right in your console to view all of your running services and other relevant errors in addition to the log view that Skaffold provides.
+* Skaffold streams the logs for all services it started. We found one combined stream of all services difficult to use and understand for anything beyond the most simple apps. Tilt instead provides a UI right in your console to view all of your running services and other relevant errors in addition to the log view that Skaffold provides.
 * Skaffold is configured with a static YAML config. Tilt is configured with a `Tiltfile`, written in a small subset of Python called [Starlark](https://github.com/bazelbuild/starlark#tour>).
 
 ## Migrate from Skaffold to Tilt

docs/_build/html/api.html

@@ -94,10 +94,10 @@
 
 
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_example.html">Running your First Tilt Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_config.html">A Simple Tiltfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Expanding a Tiltfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Optimizing a Tiltfile</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_docker_compose.html">From Docker Compose</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_skaffold.html">From Skaffold</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Tiltfile API Reference</a></li>

docs/_build/html/fast_build.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Expanding a Tiltfile &mdash; Tilt  documentation</title>
+  <title>Optimizing a Tiltfile &mdash; Tilt  documentation</title>
 
 
 
@@ -95,10 +95,10 @@
 
 
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_example.html">Running your First Tilt Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_config.html">A Simple Tiltfile</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Expanding a Tiltfile</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Optimizing a Tiltfile</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#next-steps">Next Steps</a></li>
 </ul>
 </li>
@@ -150,7 +150,7 @@
 
       <li><a href="index.html">Docs</a> &raquo;</li>
 
-      <li>Expanding a Tiltfile</li>
+      <li>Optimizing a Tiltfile</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -167,8 +167,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <div class="section" id="expanding-a-tiltfile">
-<span id="expanding-a-tiltfile"></span><h1>Expanding a Tiltfile<a class="headerlink" href="#expanding-a-tiltfile" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="optimizing-a-tiltfile">
+<span id="optimizing-a-tiltfile"></span><h1>Optimizing a Tiltfile<a class="headerlink" href="#optimizing-a-tiltfile" title="Permalink to this headline">¶</a></h1>
 <p>This tutorial looks at a <code class="docutils literal notranslate"><span class="pre">Tiltfile</span></code> with build optimizations.
 We explain what they do, and why you would want to use them.</p>
 <p>In <a class="reference external" href="first_config.md">the previous tutorial</a>, we introduced the <code class="docutils literal notranslate"><span class="pre">static_build()</span></code> function.
@@ -223,9 +223,9 @@
 </pre></div>
 </div>
 <p>It’s only one line! This line says we’re starting in a golang:1.10 container.</p>
-<p>This <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code> looks different than most <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code>s because
-it cannot contain any <code class="docutils literal notranslate"><span class="pre">ADD</span></code> or <code class="docutils literal notranslate"><span class="pre">COPY</span></code> lines.
-It’s only for setting up the environment, not for adding your code.</p>
+<p>Fast build Dockerfiles cannot contain any ADD or COPY lines.
+It’s only for setting up the environment, not for adding your code.
+So this Dockerfile might look different than most.</p>
 <ul class="simple">
 <li><code class="docutils literal notranslate"><span class="pre">repo</span> <span class="pre">=</span> <span class="pre">local_git_repo('.')</span></code></li>
 </ul>

docs/_build/html/first_config.html

@@ -31,7 +31,7 @@
   <link rel="stylesheet" href="_static/style.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Expanding a Tiltfile" href="fast_build.html" />
+    <link rel="next" title="Optimizing a Tiltfile" href="fast_build.html" />
     <link rel="prev" title="Running your First Tilt Project" href="first_example.html" />
 <!-- Global site tag (gtag.js) - Google Analytics -->
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-129150759-2"></script>
@@ -95,13 +95,13 @@
 
 
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_example.html">Running your First Tilt Project</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">A Simple Tiltfile</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#next-steps">Next Steps</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Expanding a Tiltfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Optimizing a Tiltfile</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_docker_compose.html">From Docker Compose</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_skaffold.html">From Skaffold</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Tiltfile API Reference</a></li>
@@ -281,7 +281,7 @@
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="fast_build.html" class="btn btn-neutral float-right" title="Expanding a Tiltfile" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="fast_build.html" class="btn btn-neutral float-right" title="Optimizing a Tiltfile" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="first_example.html" class="btn btn-neutral" title="Running your First Tilt Project" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

docs/_build/html/first_example.html

@@ -32,7 +32,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="A Simple Tiltfile" href="first_config.html" />
-    <link rel="prev" title="Tilt Installation Guide" href="quickstart.html" />
+    <link rel="prev" title="Tilt Installation Guide" href="install.html" />
 <!-- Global site tag (gtag.js) - Google Analytics -->
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-129150759-2"></script>
 <script>
@@ -95,13 +95,13 @@
 
 
               <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Running your First Tilt Project</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#next-steps">Next Steps</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="first_config.html">A Simple Tiltfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Expanding a Tiltfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Optimizing a Tiltfile</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_docker_compose.html">From Docker Compose</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_skaffold.html">From Skaffold</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Tiltfile API Reference</a></li>
@@ -214,7 +214,7 @@
         <a href="first_config.html" class="btn btn-neutral float-right" title="A Simple Tiltfile" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="quickstart.html" class="btn btn-neutral" title="Tilt Installation Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="install.html" class="btn btn-neutral" title="Tilt Installation Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

docs/_build/html/genindex.html

@@ -93,10 +93,10 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_example.html">Running your First Tilt Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_config.html">A Simple Tiltfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Expanding a Tiltfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Optimizing a Tiltfile</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_docker_compose.html">From Docker Compose</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_skaffold.html">From Skaffold</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Tiltfile API Reference</a></li>

docs/_build/html/index.html

@@ -31,7 +31,7 @@
   <link rel="stylesheet" href="_static/style.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Tilt Installation Guide" href="quickstart.html" />
+    <link rel="next" title="Tilt Installation Guide" href="install.html" />
 <!-- Global site tag (gtag.js) - Google Analytics -->
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-129150759-2"></script>
 <script>
@@ -94,10 +94,10 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_example.html">Running your First Tilt Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_config.html">A Simple Tiltfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Expanding a Tiltfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Optimizing a Tiltfile</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_docker_compose.html">From Docker Compose</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_skaffold.html">From Skaffold</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Tiltfile API Reference</a></li>
@@ -183,25 +183,25 @@
 <p>Download the Tilt binary on
 <a class="reference external" href="https://github.com/windmilleng/tilt/releases">the github releases page</a>.</p>
 <p>Tilt expects that you already have Docker and <code class="docutils literal notranslate"><span class="pre">kubectl</span></code> installed.
-Read the more detailed <a class="reference external" href="quickstart.html">Installation Guide</a>
+Read the more detailed <a class="reference external" href="install.html">Installation Guide</a>
 to help you <code class="docutils literal notranslate"><span class="pre">tilt</span> <span class="pre">up</span></code> quickly.</p>
 </div>
 <div class="section" id="configure-your-workflow-to-share-with-your-team">
 <span id="configure-your-workflow-to-share-with-your-team"></span><h2>Configure Your Workflow to Share With Your Team<a class="headerlink" href="#configure-your-workflow-to-share-with-your-team" title="Permalink to this headline">¶</a></h2>
 <p>Down with YAML!</p>
 <p>Configure Tilt with a <code class="docutils literal notranslate"><span class="pre">Tiltfile</span></code>, written in a small subset of Python called
-<a class="reference external" href="https://github.com/bazelbuild/starlark#tour&gt;">Starlark</a>.</p>
+<a class="reference external" href="https://github.com/bazelbuild/starlark#tour">Starlark</a>.</p>
 <p>To get started, check out some <a class="reference external" href="first_example.html">examples</a> or dive into the
 <a class="reference external" href="api.html">API reference</a>.</p>
 </div>
 <div class="section" id="next-steps">
 <span id="next-steps"></span><h2>Next Steps<a class="headerlink" href="#next-steps" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tilt Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Tilt Installation Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_example.html">Running your First Tilt Project</a></li>
 <li class="toctree-l1"><a class="reference internal" href="first_config.html">A Simple Tiltfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Expanding a Tiltfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="fast_build.html">Optimizing a Tiltfile</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_docker_compose.html">From Docker Compose</a></li>
 <li class="toctree-l1"><a class="reference internal" href="upgrade_skaffold.html">From Skaffold</a></li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Tiltfile API Reference</a></li>
@@ -218,7 +218,7 @@
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="quickstart.html" class="btn btn-neutral float-right" title="Tilt Installation Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="install.html" class="btn btn-neutral float-right" title="Tilt Installation Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
     </div>