docs(tip): adjust order of sections and wording (#651)

docs/tip/cli/README.md

@@ -7,5 +7,5 @@ For a more general usage guide, refer to the [Inertia Usage Guide](https://inert
 
 For documentation regarding the daemon API, refer to the [API Reference](https://inertia.ubclaunchpad.com/api).
 
-* Generated: 2020-Mar-06
-* Version: v0.6.0-preview2-11-g795ed90
+* Generated: 2020-Mar-18
+* Version: v0.6.0-preview2-21-g3b6aa99

docs/tip/cli/inertia_${remote_name}_token.md

@@ -14,6 +14,7 @@ inertia ${remote_name} token [flags]
 
 ```
   -h, --help   help for token
+      --ssh    generate token over SSH
 ```
 
 ### Options inherited from parent commands

docs/tip/cli/inertia_remote.md

@@ -35,8 +35,10 @@ For example:
 
 * [inertia](inertia.md)	 - Effortless, self-hosted continuous deployment for small teams and projects
 * [inertia remote add](inertia_remote_add.md)	 - Add a reference to a remote VPS instance
-* [inertia remote config-path](inertia_remote_config-path.md)	 - Output path to remote configuration.
+* [inertia remote config-path](inertia_remote_config-path.md)	 - Output path to remote configuration file
+* [inertia remote login](inertia_remote_login.md)	 - Log in to a remote as an existing user.
 * [inertia remote ls](inertia_remote_ls.md)	 - List currently configured remotes
+* [inertia remote reset](inertia_remote_reset.md)	 - Reset all remotes
 * [inertia remote rm](inertia_remote_rm.md)	 - Remove a configured remote
 * [inertia remote set](inertia_remote_set.md)	 - Update details about remote
 * [inertia remote show](inertia_remote_show.md)	 - Show details about a remote

docs/tip/cli/inertia_remote_config-path.md

@@ -1,6 +1,6 @@
 ## inertia remote config-path
 
-Output path to remote configuration.
+Output path to remote configuration file
 
 ### Synopsis
 

docs/tip/cli/inertia_remote_login.md

@@ -0,0 +1,38 @@
+## inertia remote login
+
+Log in to a remote as an existing user.
+
+### Synopsis
+
+Log in as an existing user to access a remote.
+
+```
+inertia remote login [remote] [user] [flags]
+```
+
+### Examples
+
+```
+inertia remote login staging my_user --ip 1.2.3.4
+```
+
+### Options
+
+```
+      --daemon.port string   remote daemon port (default "4303")
+  -h, --help                 help for login
+      --ip string            IP address of remote
+      --totp string          auth code or backup code for 2FA
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   specify relative path to Inertia project configuration (default "inertia.toml")
+      --simple          disable colour and emoji output
+```
+
+### SEE ALSO
+
+* [inertia remote](inertia_remote.md)	 - Configure the local settings for a remote host
+

docs/tip/cli/inertia_remote_reset.md

@@ -0,0 +1,31 @@
+## inertia remote reset
+
+Reset all remotes
+
+### Synopsis
+
+Removes all inertia remotes configuration - use 'inertia remote config-path'
+to see where the file is directly. Note that the configuration directory can be set using
+INERTIA_PATH.
+
+```
+inertia remote reset [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for reset
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   specify relative path to Inertia project configuration (default "inertia.toml")
+      --simple          disable colour and emoji output
+```
+
+### SEE ALSO
+
+* [inertia remote](inertia_remote.md)	 - Configure the local settings for a remote host
+

docs/tip/cli/inertia_remote_upgrade.md

@@ -21,7 +21,7 @@ inertia remote upgrade dev staging
 ```
       --all              upgrade all remotes
   -h, --help             help for upgrade
-      --version string   specify Inertia daemon version to set (default "v0.6.0-preview2-11-g795ed90")
+      --version string   specify Inertia daemon version to set (default "v0.6.0-preview2-21-g3b6aa99")
 ```
 
 ### Options inherited from parent commands

docs/tip/index.html

@@ -286,9 +286,6 @@
                   <li>
                     <a href="#generating-api-keys" class="toc-h2 toc-link" data-title="Generating API Keys">Generating API Keys</a>
                   </li>
-                  <li>
-                    <a href="#inertia-release-streams" class="toc-h2 toc-link" data-title="Inertia Release Streams">Inertia Release Streams</a>
-                  </li>
                   <li>
                     <a href="#custom-ssl-certificate" class="toc-h2 toc-link" data-title="Custom SSL Certificate">Custom SSL Certificate</a>
                   </li>
@@ -367,18 +364,24 @@ <h1 id='inertia'>Inertia</h1>
 
 <p>This site primarily documents how to set up and use Inertia - to learn more
 about the project, check out our <a href="https://github.com/ubclaunchpad/inertia">GitHub repository</a>!
-A complete command reference for the Inertia CLI is also available <a href="/cli">here</a>.
-If you&#39;re interested in building on Inertia, check out the <a href="/api">API reference</a>.</p>
+Additional resources you might want to consult include:</p>
 
-<p>If you&#39;re looking for the latest pre-release documentation, check out the
-<a href="https://inertia.ubclaunchpad.com/tip"><em>preview</em> versions of our documentation</a>.
-Note that <code>/tip</code> documentation includes unreleased features and changes.</p>
+<ul>
+<li><a href="/cli">complete command reference for the Inertia CLI</a></li>
+<li><a href="/api">API reference for the Inertia daemon</a></li>
+</ul>
 
 <aside class="notice">
 This page is a <b>work in progress</b> - if anything seems incomplete or unclear,
 please feel free to
 <a href='https://github.com/ubclaunchpad/inertia/issues/new/choose'>open a ticket</a>!
 </aside>
+
+<aside class="warning">
+If you're looking for the latest pre-release documentation, check out the
+<a href="https://inertia.ubclaunchpad.com/tip"><i>preview</i> versions of our documentation</a>.
+Note that <code>/tip/...</code> documentation includes unreleased features and changes.
+</aside>
 <h1 id='getting-started'>Getting Started</h1>
 <blockquote>
 <p>MacOS users can install the CLI using <a href="https://brew.sh">Homebrew</a>:</p>
@@ -892,7 +895,24 @@ <h1 id='upgrading'>Upgrading</h1>
 </blockquote>
 <pre class="highlight shell tab-shell"><code>inertia <span class="k">${</span><span class="nv">remote_name</span><span class="k">}</span> upgrade --all
 </code></pre>
-<p>TODO</p>
+<p>The version of Inertia you are using can be seen in Inertia&#39;s <code>inertia.toml</code>
+configuration file, or by running <code>inertia --version</code>. The version in
+<code>inertia.toml</code> is used to determine what version of the Inertia daemon to use
+when you run <code>inertia ${remote_name} init</code>.</p>
+
+<p>You can manually change the daemon version used by editing the Inertia
+configuration file. If you are building from source, you can also check out the
+desired version and run <code>make inertia-tagged</code> or <code>make RELEASE=$STREAM</code>.
+Inertia daemon releases are tagged as follows:</p>
+
+<ul>
+<li><code>v0.x.x</code> denotes <a href="https://github.com/ubclaunchpad/inertia/releases">official, tagged releases</a> - these are recommended.</li>
+<li><code>latest</code> denotes the newest builds on <code>master</code>.</li>
+<li><code>canary</code> denotes experimental builds used for testing and development - do not use this.</li>
+</ul>
+
+<p>You can see the list of available tags on
+<a href="https://cloud.docker.com/u/ubclaunchpad/repository/docker/ubclaunchpad/inertia/tags">Docker Hub</a>.</p>
 <h1 id='advanced-usage'>Advanced Usage</h1>
 <p>This section details various advanced usage tips. If you can&#39;t find what you&#39;re
 looking for here, try using the <code>--help</code> flag on relevant commands - Inertia
@@ -1001,31 +1021,6 @@ <h2 id='generating-api-keys'>Generating API Keys</h2><pre class="highlight shell
 <p>To use these tokens, you can place them in your <code>inertia.toml</code> under <code>token</code>, or
 use them in requests to the Inertia API by placing them as a <code>Bearer</code> token in
 your request header under <code>Authorization</code>.</p>
-<h2 id='inertia-release-streams'>Inertia Release Streams</h2>
-<p>The version of Inertia you are using can be seen in Inertia&#39;s <code>inertia.toml</code>
-configuration file, or by running <code>inertia --version</code>. The version in
-<code>inertia.toml</code> is used to determine what version of the Inertia daemon to use
-when you run <code>inertia ${remote_name} init</code>.</p>
-
-<blockquote>
-<p>To switch over to the latest build and upgrade your remote:</p>
-</blockquote>
-<pre class="highlight shell tab-shell"><code>inertia config <span class="nb">set </span>version <span class="s2">"latest"</span>
-inertia <span class="k">${</span><span class="nv">remote_name</span><span class="k">}</span> upgrade
-</code></pre>
-<p>You can manually change the daemon version used by editing the Inertia
-configuration file. If you are building from source, you can also check out the
-desired version and run <code>make inertia-tagged</code> or <code>make RELEASE=$STREAM</code>.
-Inertia daemon releases are tagged as follows:</p>
-
-<ul>
-<li><code>v0.x.x</code> denotes <a href="https://github.com/ubclaunchpad/inertia/releases">official, tagged releases</a> - these are recommended.</li>
-<li><code>latest</code> denotes the newest builds on <code>master</code>.</li>
-<li><code>canary</code> denotes experimental builds used for testing and development - do not use this.</li>
-</ul>
-
-<p>You can see the list of available tags on
-<a href="https://cloud.docker.com/u/ubclaunchpad/repository/docker/ubclaunchpad/inertia/tags">Docker Hub</a>.</p>
 <h2 id='custom-ssl-certificate'>Custom SSL Certificate</h2>
 <p>By default, the Inertia daemon generates a self-signed SSL certificate for its
 API. This means that Inertia, by default, doesn&#39;t verify SSL communications,
@@ -1045,10 +1040,6 @@ <h2 id='intermediary-containers'>Intermediary Containers</h2>
 This is an experimental solution to a problem we've run into - refer to
 <a href="https://github.com/ubclaunchpad/inertia/issues/607">#607</a> for more details.
 </aside>
-
-<p>You can declare intermediary containers used during builds that don&#39;t persist for the lifetime of
-your project - for example, containers that run tasks. This tells the Inertia daemon not to worry
-if it detects that containers with the given names die.</p>
 <pre class="highlight toml tab-toml"><code><span class="py">name</span> <span class="p">=</span> <span class="s">"my_project"</span>
 <span class="c"># ...</span>
 
@@ -1057,7 +1048,11 @@ <h2 id='intermediary-containers'>Intermediary Containers</h2>
   <span class="nn">[profile.build]</span>
     <span class="c"># ...</span>
     <span class="py">intermediary_containers</span> <span class="p">=</span> <span class="p">[</span> <span class="s">"nginx"</span> <span class="p">]</span>
-</code></pre><h1 id='miscellaneous'>Miscellaneous</h1><h2 id='learn-more'>Learn More</h2>
+</code></pre>
+<p>You can declare &quot;intermediary&quot; containers used during builds that don&#39;t persist for the lifetime of
+your project - for example, containers that run tasks. This tells the Inertia daemon not to worry
+if it detects that containers with the given names die.</p>
+<h1 id='miscellaneous'>Miscellaneous</h1><h2 id='learn-more'>Learn More</h2>
 <blockquote>
 <p>Some quick links to help you get started:</p>
 

docs_src/index.html.md

@@ -58,19 +58,23 @@ started to address these problems.
 
 This site primarily documents how to set up and use Inertia - to learn more
 about the project, check out our [GitHub repository](https://github.com/ubclaunchpad/inertia)!
-A complete command reference for the Inertia CLI is also available [here](/cli).
-If you're interested in building on Inertia, check out the [API reference](/api).
+Additional resources you might want to consult include:
 
-If you're looking for the latest pre-release documentation, check out the
-[*preview* versions of our documentation](https://inertia.ubclaunchpad.com/tip).
-Note that `/tip` documentation includes unreleased features and changes.
+* [complete command reference for the Inertia CLI](/cli)
+* [API reference for the Inertia daemon](/api)
 
 <aside class="notice">
 This page is a <b>work in progress</b> - if anything seems incomplete or unclear,
 please feel free to
 <a href='https://github.com/ubclaunchpad/inertia/issues/new/choose'>open a ticket</a>!
 </aside>
 
+<aside class="warning">
+If you're looking for the latest pre-release documentation, check out the
+<a href="https://inertia.ubclaunchpad.com/tip"><i>preview</i> versions of our documentation</a>.
+Note that <code>/tip/...</code> documentation includes unreleased features and changes.
+</aside>
+
 # Getting Started
 > MacOS users can install the CLI using [Homebrew](https://brew.sh):
 
@@ -588,7 +592,22 @@ inertia --version # verify installation
 inertia ${remote_name} upgrade --all
 ```
 
-TODO
+The version of Inertia you are using can be seen in Inertia's `inertia.toml`
+configuration file, or by running `inertia --version`. The version in
+`inertia.toml` is used to determine what version of the Inertia daemon to use
+when you run `inertia ${remote_name} init`.
+
+You can manually change the daemon version used by editing the Inertia
+configuration file. If you are building from source, you can also check out the
+desired version and run `make inertia-tagged` or `make RELEASE=$STREAM`.
+Inertia daemon releases are tagged as follows:
+
+- `v0.x.x` denotes [official, tagged releases](https://github.com/ubclaunchpad/inertia/releases) - these are recommended.
+- `latest` denotes the newest builds on `master`.
+- `canary` denotes experimental builds used for testing and development - do not use this.
+
+You can see the list of available tags on
+[Docker Hub](https://cloud.docker.com/u/ubclaunchpad/repository/docker/ubclaunchpad/inertia/tags).
 
 # Advanced Usage
 
@@ -720,32 +739,6 @@ To use these tokens, you can place them in your `inertia.toml` under `token`, or
 use them in requests to the Inertia API by placing them as a `Bearer` token in
 your request header under `Authorization`.
 
-## Inertia Release Streams
-
-The version of Inertia you are using can be seen in Inertia's `inertia.toml`
-configuration file, or by running `inertia --version`. The version in
-`inertia.toml` is used to determine what version of the Inertia daemon to use
-when you run `inertia ${remote_name} init`.
-
-> To switch over to the latest build and upgrade your remote:
-
-```shell
-inertia config set version "latest"
-inertia ${remote_name} upgrade
-```
-
-You can manually change the daemon version used by editing the Inertia
-configuration file. If you are building from source, you can also check out the
-desired version and run `make inertia-tagged` or `make RELEASE=$STREAM`.
-Inertia daemon releases are tagged as follows:
-
-- `v0.x.x` denotes [official, tagged releases](https://github.com/ubclaunchpad/inertia/releases) - these are recommended.
-- `latest` denotes the newest builds on `master`.
-- `canary` denotes experimental builds used for testing and development - do not use this.
-
-You can see the list of available tags on
-[Docker Hub](https://cloud.docker.com/u/ubclaunchpad/repository/docker/ubclaunchpad/inertia/tags).
-
 ## Custom SSL Certificate
 
 By default, the Inertia daemon generates a self-signed SSL certificate for its
@@ -772,10 +765,6 @@ This is an experimental solution to a problem we've run into - refer to
 <a href="https://github.com/ubclaunchpad/inertia/issues/607">#607</a> for more details.
 </aside>
 
-You can declare intermediary containers used during builds that don't persist for the lifetime of
-your project - for example, containers that run tasks. This tells the Inertia daemon not to worry
-if it detects that containers with the given names die.
-
 ```toml
 name = "my_project"
 # ...
@@ -787,6 +776,10 @@ name = "my_project"
     intermediary_containers = [ "nginx" ]
 ```
 
+You can declare "intermediary" containers used during builds that don't persist for the lifetime of
+your project - for example, containers that run tasks. This tells the Inertia daemon not to worry
+if it detects that containers with the given names die.
+
 # Miscellaneous
 
 ## Learn More