Merge branch 'master' into packagecloud

Author: michelle-luna

jekyll/_cci2/browser-testing.md

@@ -96,8 +96,10 @@ jobs:
             wget --retry-connrefused --no-check-certificate -T 60 localhost:4445  # wait for app to be ready
       - run: # base image is python, so we run `nosetests`, an extension of `unittest`
           command: nosetests
-      - run: # wait for Sauce Connect to close the tunnel
-          command: killall --wait sc  
+      - run:
+          name: Shut Down Sauce Connect Tunnel
+          command: |
+            kill -9 `cat /tmp/sc_client.pid`          
 ```
 
 ## BrowserStack and Appium

jekyll/_cci2/build.md

@@ -1,7 +1,7 @@
 ---
 layout: classic-docs
-title: "Docker, Machine, and iOS Builds"
-description: "CircleCI 2.0 Configuration"
+title: "Build Environments"
+description: "CircleCI 2.0 Build Environment Configuration"
 ---
 
 

jekyll/_cci2/caching.md

@@ -337,13 +337,13 @@ before restoring dependencies from cache.
 
 ```yaml
 steps:
-  - run: bundle install & bundle clean
   - restore_cache:
       keys:
         # when lock file changes, use increasingly general patterns to restore cache
         - v1-gem-cache-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
         - v1-gem-cache-{{ arch }}-{{ .Branch }}-
         - v1-gem-cache-{{ arch }}-
+  - run: bundle install && bundle clean
   - save_cache:
       paths:
         - ~/.bundle

jekyll/_cci2/contexts.md

@@ -36,7 +36,7 @@ For any GitHub Enterprise (GHE) installation that includes multiple organization
 
 3. Click the Add Environment Variable button and copy/paste in the variable name and value. Click the Add Variable button to save it.
 
-4. Add the `context: <context name>` key to the [`workflows`]({{ site.baseurl }}/2.0/configuration-reference/#workflows section of your [`config.yml`]({{ site.baseurl }}/2.0/configuration-reference/) file for every job in which you want to use the variable. In the following example, the `run-tests` job will use the variables set in the `org-global` context.
+4. Add the `context: <context name>` key to the [`workflows`]({{ site.baseurl }}/2.0/configuration-reference/#workflows) section of your [`config.yml`]({{ site.baseurl }}/2.0/configuration-reference/) file for every job in which you want to use the variable. In the following example, the `run-tests` job will use the variables set in the `org-global` context.
 
 ```
 workflows:

jekyll/_cci2/demo-apps.md

@@ -7,12 +7,13 @@ categories: [language-guides]
 order: 0
 ---
 
-Code that builds on Linux or iOS will generally build on CircleCI 2.0. We’ve created several demo applications in various languages, so you can learn by example form an app written in the same laguage as your application. Each language listed below has an associated guide and public repository on GitHub. Fork them and follow along!
+Code that builds on Linux or iOS will generally build on CircleCI 2.0. We’ve created several demo applications in various languages, so you can learn by example from an app written in the same laguage as your application. Each language listed below has an associated guide and public repository on GitHub. Fork them and follow along!
 
 Language Guide | Framework | GitHub Repo Name
  ---------|-----------|-----------------
  [Android](https://github.com/CircleCI-Public/circleci-demo-react-native/blob/master/README.md){:target="_blank"} | React Native | [circleci-demo-react-native]{:target="_blank"}
  [Clojure]{:target="_blank"} | Luminus | [circleci-demo-clojure-luminus]{:target="_blank"}
+ [Crystal]({{ site.baseurl }}/2.0/language-crystal/) | Kemal | [circleci-demo-crystal](https://github.com/teesloane/circleci-demo-crystal)
  [Elixir]{:target="_blank"} | Phoenix | [circleci-demo-elixir-phoenix]{:target="_blank"}
  [Go]{:target="_blank"} | Go | [circleci-demo-go]{:target="_blank"}
  [iOS]{:target="_blank"} | Xcode | [circleci-demo-ios]{:target="_blank"}
@@ -24,6 +25,7 @@ Language Guide | Framework | GitHub Repo Name
  [Python]({{ site.baseurl }}/2.0/project-walkthrough/){:target="_blank"} | Flask | [circleci-demo-python-flask]{:target="_blank"}
  [React Native](https://github.com/CircleCI-Public/circleci-demo-react-native/blob/master/README.md){:target="_blank"} | React Native | [circleci-demo-react-native]{:target="_blank"}
  [Ruby and Rails]{:target="_blank"} | Rails | [circleci-demo-ruby-rails]{:target="_blank"}
+ [Scala]({{ site.baseurl }}/2.0/language-scala/){:target="_blank"} | sbt | [samplescala](https://github.com/ariv3ra/samplescala){:target="_blank"}
 {: class="table"}
 
 ## Supported Languages
@@ -36,9 +38,14 @@ Language Guide | Framework | GitHub Repo Name
 - Python (Python 2 and later)
 - React Native
 - Ruby and Rails (Ruby 2 and later)
+- Scala and sbt
 
 Build projects in C, C#, C++, Clojure, Elixir, Erlang, Go, Groovy, Haskell, Haxe, Java, JavaScript, Node.js, Perl, PHP, Python, Ruby, Rust, Scala and many more.
 
+## See Also
+
+Refer to the [Getting Started Introduction] for the steps to run your first build.
+
 
 [Android]: {{ site.baseurl }}/2.0/language-android/
 [Clojure]: {{ site.baseurl }}/2.0/language-clojure/

jekyll/_cci2/language-crystal.md

@@ -0,0 +1,61 @@
+---
+layout: classic-docs
+title: "Language Guide: Crystal"
+short-title: "Crystal"
+description: "Building and Testing with Crystal on CircleCI 2.0"
+categories: [language-guides]
+order: 9
+---
+
+*[Tutorials & 2.0 Sample Apps]({{ site.baseurl }}/2.0/tutorials/) > Language Guide: Crystal*
+
+This guide will help you get started with a minimal Crystal application on CircleCI. 
+
+## Overview
+
+If you’re in a rush, just copy the sample configuration below into a `.circleci/config.yml` in your project’s root directory and start building.
+
+You can view an example Crystal project at the following link:
+
+- <a href="https://github.com/teesloane/circleci-demo-crystal" 
+target="_blank">Demo Crystal Project on Github</a>
+
+In the project you will find a commented CircleCI configuration file <a href="https://github.com/teesloane/circleci-demo-crystal/blob/master/.circleci/config.yml" target="_blank">`.circleci/config.yml`</a>.
+
+The application uses Crystal 0.26 and Kemal 0.24. Both Crystal and Kemal are
+developing quickly. Altering the Docker image to the `:latest` version may cause
+breaking changes.
+
+## Sample Configuration
+
+{% raw %}
+```
+version: 2 # use CircleCI 2.0
+jobs: # a collection of jobs
+  build: 
+    working_directory: ~/demo_app
+    docker: # run build steps with docker
+      - image: crystallang/crystal:0.26.0 # primary docker container; all `steps` will run here.
+    steps: # a collection of executable steps
+      - checkout # checks out source code to working directory
+      - restore_cache: # Restore dependency cache
+          key: dependency-cache-{{ checksum "shard.lock" }}
+      - run:
+          name: Install dependencies.
+          command: shards install
+      - save_cache: # Step to save dependency cache
+          key: dependency-cache-{{ checksum "shard.lock" }}
+          paths:
+            - ./lib
+      - run:
+          name: test
+          command: crystal spec
+# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples    
+```
+{% endraw %}
+
+Great! You've set up CircleCI 2.0 for a basic Crystal application.
+
+## Deploy
+
+See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.

jekyll/_cci2/project-build.md

@@ -15,6 +15,16 @@ After a software repository on GitHub or Bitbucket is authorized and added as a
 
 ## Adding Projects
 
+A CircleCI project shares the name of the associated code repository and is visible on the Projects page of the CircleCI app. Projects are added by using the Add Project button.
+
+## Add Projects Page
+
+![header]({{ site.baseurl }}/assets/img/docs/CircleCI-2.0-setup-project-circle101.png)
+
+*Following* a project enables a user to subscribe to [email notifications]({{ site.baseurl }}/2.0/notifications/) for the project [build status]({{ site.baseurl }}/2.0/status/) and adds the project to their CircleCI dashboard.
+
+The *Project Administrator* is the user who adds a GitHub or Bitbucket repository to CircleCI as a Project. A *User* is an individual user within an org. A CircleCI user is anyone who can log in to the CircleCI platform with a username and password. Users must be added to a [GitHub or Bitbucket org]({{ site.baseurl }}/2.0/gh-bb-integration/) to view or follow associated CircleCI projects.  Users may not view project data that is stored in environment variables.
+
 If you do not see your project and it is not currently building on CircleCI, check your Organization in the top left corner of the CircleCI application.  For example, if the top left shows your user `myUser`, only Github projects belonging to `myUser` will be available under `Add Projects`.  If you want to build the Github project `myOrg/orgProject`, you must select `myOrg` on the application Switch Organization menu.
 
 ![Switch Organization Menu]({{ site.baseurl }}/assets/img/docs/org-centric-ui.png)

jekyll/_cci2/sample-config.md

@@ -7,9 +7,7 @@ categories: [migration]
 order: 2
 ---
 
-*[Tutorials & Sample Apps]({{ site.baseurl }}/2.0/tutorials/) > Sample 2.0 config.yml Files*
-
-This document provides three sample `.circleci/config.yml` files, as follows:
+This document provides three sample [`.circleci/config.yml`]({{ site.baseurl }}/2.0/configuration-reference/) files, as follows:
 
 * TOC
 {:toc}
@@ -301,3 +299,7 @@ workflows:
 ```
 
 {% endraw %}
+
+## See Also
+
+See the [Example Public Repos] document for a list of public projects that use CircleCI.

jekyll/_cci2/security.md

@@ -5,7 +5,6 @@ category: [administration]
 order: 5
 description: "CircleCI security features."
 ---
-*[Reference]({{ site.baseurl }}/2.0/reference/) > Security Features*
 
 This document outlines security features built into CircleCI and related integrations.
 
@@ -63,6 +62,8 @@ Complete Audit logs may be downloaded from the Audit Log page within the Admin s
 **Note:** In some situations, the internal machinery may generate duplicate events in the audit logs. The `id` field of the downloaded logs is unique per event and can be used to identify duplicate entries.
 
 ### Audit Log Events
+{:.no_toc}
+
 <!-- TODO: automate this from event-cataloger -->
 Following are the system events that are logged. See `action` in the Field section below for the definition and format.
 
@@ -83,6 +84,8 @@ Following are the system events that are logged. See `action` in the Field secti
 
 
 ### Audit Log Fields
+{:.no_toc}
+
 - **action:** The action taken that created the event. The format is ASCII lowercase words separated by dots, with the entity acted upon first and the action taken last. In some cases entities are nested, for example, `workflow.job.start`.
 - **actor:** The actor who performed this event. In most cases this will be a CircleCI user. This data is a JSON blob that will always contain `id` and and `type` and will likely contain `name`.
 - **target:** The entity instance acted upon for this event, for example, a project, an org, an account, or a build. This data is a JSON blob that will always contain `id` and and `type` and will likely contain `name`.
@@ -95,3 +98,7 @@ Following are the system events that are logged. See `action` in the Field secti
 - **success:** A flag to indicate if the action was successful.
 - **request:** If this event was triggered by an external request this data will be populated and may be used to connect events that originate from the same external request. The format is a JSON blob containing `id` (the request ID assigned to this request by CircleCI), `ip_address` (the original IP address in IPV4 dotted notation from which the request was made, eg. 127.0.0.1), and `client_trace_id` (the client trace ID header, if present, from the 'X-Client-Trace-Id' HTTP header of the original request).
 
+## See Also
+{:.no_toc}
+
+[GitHub and Bitbucket Integration]({{ site.baseurl }}/2.0/gh-bb-integration/)

jekyll/_cci2/settings.md

@@ -7,21 +7,21 @@ categories: [settings]
 order: 2
 ---
 
-CircleCI provides a Project and Org settings with encrypted storage in the CircleCI app.
+CircleCI provides Project and Org settings with encrypted storage in the CircleCI app.
 
 ## Project Settings Page
 
 ![settings]( {{ site.baseurl }}/assets/img/docs/settings.png)
 
 
-
 ## Organization Settings Page
 For your [Org Plan or Billing settings]({{ site.baseurl }}/2.0/faq/#billing), see the Settings tab of the CircleCI app for summary data about your usage.
 <hr>
 
-Plans and Billing | Contexts
-------------------------|------------------
-For your [Org Plan or Billing settings]({{ site.baseurl }}/2.0/faq/#billing), see the Settings tab of the CircleCI app for summary data about your usage. |  Share environment variables across projects with a Workflow key, on the [contexts page]({{ site.baseurl }}/2.0/contexts/).
-
 ![settings]( {{ site.baseurl }}/assets/img/docs/plan-settings.png)
 
+## See Also
+
+- Plans and Billing -- For your [Org Plan or Billing settings]({{ site.baseurl }}/2.0/faq/#billing), see the Settings tab of the CircleCI app for summary data about your usage. 
+- Cntexts --  Share environment variables across projects with a Workflow key, on the [contexts page]({{ site.baseurl }}/2.0/contexts/).
+

jekyll/_cci2/skip-build.md

@@ -7,8 +7,6 @@ categories: [configuring-jobs]
 order: 100
 ---
 
-_[Basics]({{ site.baseurl }}/2.0/basics/) > Skip and Cancel Builds_
-
 This document describes how to
 skip or cancel builds in the following sections.
 
@@ -38,6 +36,7 @@ Otherwise, click one of the Rebuild options on the **Job page** of the CircleCI
 This feature is not supported for fork PRs.
 
 ### Example Commit Title
+{:.no_toc}
 
 ```bash
 $ git log origin/master..HEAD
@@ -54,6 +53,7 @@ this commit will not be built on CircleCI
 because of the `[ci skip]` in the commit title.
 
 ### Example Commit Description
+{:.no_toc}
 
 ```bash
 $ git log origin/master..HEAD
@@ -97,6 +97,7 @@ This feature only applies to non-workflow builds, builds triggered by pushes to
 
 
 ### Steps to Enable Auto-Cancel for New Builds Triggered by Pushes to GitHub without Workflows
+{:.no_toc}
 
 1. In the CircleCI application,
 go to your project's settings
@@ -110,6 +111,7 @@ click the **On** button.
 
 
 ### Steps to Enable Auto-Cancel for Workflows Triggered by Pushes to GitHub or the API
+{:.no_toc}
 
 Projects for which auto-cancel is enabled in the Advanced Settings will have workflows on non-default branches cancelled when a newer build is triggered on that same branch. 
 

jekyll/_cci2/ssh-access-jobs.md

@@ -7,8 +7,6 @@ categories: [troubleshooting]
 order: 20
 ---
 
-*[Basics]({{ site.baseurl }}/2.0/basics/) > Debugging with SSH*
-
 This document describes how to access a build container using SSH on CircleCI 2.0 in the following sections:
 
 * TOC
@@ -51,6 +49,7 @@ If you run into permission troubles trying to SSH to your job, try
 these things:
 
 ### Ensure Authentication With GitHub/Bitbucket
+{:.no_toc}
 
 A single command can be used to test that your keys are set up as expected. For 
 GitHub run:
@@ -82,6 +81,7 @@ If you _don't_ see output like that, you need to start by
 [troubleshooting your SSH keys with Bitbucket](https://confluence.atlassian.com/bitbucket/troubleshoot-ssh-issues-271943403.html).
 
 ### Ensure Authenticating as the Correct User
+{:.no_toc}
 
 If you have multiple accounts, double-check that you are
 authenticated as the right one!
@@ -94,6 +94,7 @@ by offering a different SSH key with `ssh -i`. See the next section if
 you need a hand figuring out which key is being offered.
 
 ### Ensure the Correct Key is Offered to CircleCI
+{:.no_toc}
 
 If you've verified that you can authenticate as the correct
 user, but you're still getting "Permission denied" from CircleCI, you
@@ -138,3 +139,8 @@ argument to SSH. For example:
 ```
 $ ssh -i /Users/me/.ssh/id_rsa_github -p 64784 [email protected]
 ```
+
+## See Also
+{:.no_toc}
+
+[GitHub and Bitbucket Integration](  {{ site.baseurl }}/2.0/gh-bb-integration/)

jekyll/_cci2/status-badges.md

@@ -1,10 +1,9 @@
 ---
 layout: classic-docs
 title: Adding Status Badges
+description: How to embed a CircleCI status badge in any web page or document
 ---
 
-[Basics]({{ site.baseurl }}/2.0/basics/) > Adding Status Badges
-
 This document describes how to create a badge that displays your project's build status (passed or failed) in a README or other document.
 
 ## Overview
@@ -48,3 +47,7 @@ you can use the [shield style](https://shields.io/).
 To use the shield style,
 replace `style=svg` with `style=shield`
 in the link you generated above.
+
+## See Also
+
+[Status]({{ site.baseurl }}/2.0/status/