Merge pull request #135 from netlify/docs-site-tweaks

Some docs tweaks
netlify · Oct 8, 2018 · 2176c63 · 2176c63
2 parents 76c57ea + 4660cf0
commit 2176c63
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,9 @@
 
 Welcome to the Netlify CLI! The new 2.0 version (now in beta) was rebuilt from the ground up to help improve the site building experience.
 
+- See our [Getting Started Guide](https://www.netlify.com/docs/cli/) for a comprehensive introduction to the CLI.
+- See the [CLI website](http://cli.netlify.com/) for online access to CLI help text.
+
 ## Table of Contents
 
 <!-- AUTO-GENERATED-CONTENT:START (TOC:collapse=true&collapseText=Click to expand) -->

diff --git a/appveyor.yml b/appveyor.yml
@@ -1,8 +1,8 @@
 environment:
   matrix:
     # node.js
-    - nodejs_version: '8'
     - nodejs_version: '10'
+    # - nodejs_version: '8'
 
 cache:
   - '%APPDATA%\npm-cache'

diff --git a/docs/commands/deploy.md b/docs/commands/deploy.md
@@ -9,6 +9,11 @@ Create a new deploy from the contents of a folder
 
 Deploys from the build settings found in the netlify.toml file, or settings from the api.
 
+The following environment variables can be used to override configuration file lookups and prompts:
+
+- NETLIFY_AUTH_TOKEN - an access token to use when authenticating commands. KEEP THIS VALUE PRIVATE
+- NETLIFY_SITE_ID - force the cli to think the cwd is linked to this site id. This can be made public.
+
 
 **Usage**
 

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -6,4 +6,4 @@ title: Contributing to the Netlify CLI
 
 If you'd like to contribute to the CLI please checkout the repo!
 
-[CLI repo](https://github.com/netlify/cli/blob/master/CONTRIBUTING.md)
+[CONTRIBUTING.md](https://github.com/netlify/cli/blob/master/CONTRIBUTING.md)
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/index.md b/docs/index.md
@@ -5,10 +5,9 @@ description: Netlify Command line interface (CLI) documentation
 
 # Netlify CLI
 
-Welcome to the Netlify CLI!
+Welcome to the Netlify CLI!  This site provides online access to all help strings in the Netlify CLI.  For a more in-depth guide, please see our [Getting Started](https://www.netlify.com/docs/cli/) guide on our main docs site.
 
-The new Netlify CLI was designed from the ground up to help improve the site building experience.
-
-- [Getting Started](/getting-started)
+- [Getting Started](https://www.netlify.com/docs/cli/)
 - [Commands](/commands)
 - [Contributing](/contributing)
+- [Github](https://github.com/netlify/cli/)
diff --git a/src/commands/deploy.js b/src/commands/deploy.js
@@ -186,6 +186,11 @@ class DeployCommand extends Command {
 DeployCommand.description = `${renderShortDesc(`Create a new deploy from the contents of a folder`)}
 
 Deploys from the build settings found in the netlify.toml file, or settings from the api.
+
+The following environment variables can be used to override configuration file lookups and prompts:
+
+- NETLIFY_AUTH_TOKEN - an access token to use when authenticating commands. KEEP THIS VALUE PRIVATE
+- NETLIFY_SITE_ID - force the cli to think the cwd is linked to this site id. This can be made public.
 `
 
 DeployCommand.examples = [
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ title: Contributing to the Netlify CLI

		If you'd like to contribute to the CLI please checkout the repo!

		[CLI repo](https://github.com/netlify/cli/blob/master/CONTRIBUTING.md)
		[CONTRIBUTING.md](https://github.com/netlify/cli/blob/master/CONTRIBUTING.md)