Skip to content

Commit c6d164e

Browse files
authored
add brief descriptions for all 2.0 docs (circleci#944)
* add brief descriptions for all 2.0 docs * add missing description
1 parent 8ea04fa commit c6d164e

30 files changed

+32
-2
lines changed

jekyll/_cci2/about-circleci.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "About CircleCI"
44
short-title: "About CircleCI"
5+
description: "Starting point for CircleCI 2.0 docs"
56
categories: [getting-started]
67
order: 1
78
---

jekyll/_cci2/artifacts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Uploading Build Artifacts"
44
short-title: "Uploading Build Artifacts"
5+
description: "Example of uploading artifacts created during a build"
56
categories: [configuring-jobs]
67
order: 60
78
---

jekyll/_cci2/building-docker-images.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Building Docker Images on CircleCI 2.0"
44
short-title: "Building Docker Images"
5+
description: "How to build Docker images and access remote services"
56
categories: [docker]
67
order: 0
78
---

jekyll/_cci2/caching.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Caching in CircleCI"
44
short-title: "Caching"
5+
description: "Caching strategies to increase build speeds"
56
categories: [configuring-jobs]
67
order: 20
78
---

jekyll/_cci2/configuration-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Configuration Reference"
44
short-title: "Configuration"
5+
description: "Reference for .circleci/config.yml"
56
categories: [reference]
67
order: 0
78
---

jekyll/_cci2/custom-images.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Building Custom Images for Docker Executor"
44
short-title: "Building Custom Images"
5+
description: "Why and how to create custom Docker images"
56
categories: [configuring-jobs]
67
order: 30
78
---

jekyll/_cci2/defining-multiple-jobs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Defining Multiple Jobs"
44
short-title: "Defining Multiple Jobs"
5+
description: "How to define and trigger non-build jobs"
56
categories: [configuring-jobs]
67
order: 80
78
---

jekyll/_cci2/demo-apps.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "CircleCI Demo Applications"
44
short-title: "Demo App Index"
5+
description: "A list of demo applications for several popular languages"
56
categories: [language-guides]
67
order: 0
78
---

jekyll/_cci2/deployments.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Deployments"
44
short-title: "Deployments"
5+
description: "How to set up conditional deployment"
56
categories: [configuring-jobs]
67
order: 70
78
---

jekyll/_cci2/docker-compose.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Using docker-compose"
44
short-title: "Using docker-compose"
5+
description: "How to enable docker-compose in your primary container"
56
categories: [docker]
67
order: 2
78
---

jekyll/_cci2/docker-layer-caching.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Docker Layer Caching"
44
short-title: "Docker Layer Caching"
5+
description: "How to reuse unchanged cache layers to reduce build time"
56
categories: [docker]
67
order: 5
78
---

jekyll/_cci2/env-vars.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "CircleCI 2.0 Environment Variables"
44
short-title: "Environment Variables"
5+
description: "A list of supported environment variables in CircleCI 2.0"
56
categories: [reference]
67
order: 1
78
---

jekyll/_cci2/executor-types.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Choosing an Executor Type"
44
short-title: "Executor Types"
5+
description: "Overviews of the docker and machine executor types"
56
categories: [configuring-jobs]
67
order: 0
78
---

jekyll/_cci2/faq.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Frequently Asked Questions (FAQ)"
44
short-title: "FAQ"
5+
description: "Frequently asked questions about CircleCI 2.0"
56
categories: [getting-started]
67
order: 50
78
---
@@ -10,7 +11,7 @@ order: 50
1011

1112
**Linux:** CircleCI is a very flexible platform so you should be able to **build almost any kind of application that will run on Linux**. It doesn't have to be a web application!
1213

13-
**Android:** Although Android is not officially supported on 2.0 at this time, you can build Android apps on the 2.0 platform, [this post](https://discuss.circleci.com/t/thank-you-and-android-build-example/11298) has an excellent example of a customer successfully building Android on 2.0. **Note that this example does not use the emulator so it's not affected by the incompatibility between Docker and the Android emulator.** We will explain ways to run the Android emulator in future 2.0 documentation updates. Full documentation for building Android apps on 2.0 is coming soon.
14+
**Android:** Although Android is not officially supported on 2.0 at this time, you can build Android apps on the 2.0 platform, [this post](https://discuss.circleci.com/t/thank-you-and-android-build-example/11298) has an excellent example of a customer successfully building Android on 2.0. **Note that this example does not use the emulator so it's not affected by the incompatibility between Docker and the Android emulator.** We will explain ways to run the Android emulator in future 2.0 documentation updates. Full documentation for building Android apps on 2.0 is coming soon.
1415

1516
**iOS:** Building iOS apps is not yet supported on CircleCI 2.0. Please refer to our documentation for [iOS on 1.0]({{ site.baseurl }}/1.0/mobile/) until 2.0 support is available.
1617

jekyll/_cci2/first-steps.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "First Steps with CircleCI"
44
short-title: "First Steps"
5+
description: "First steps for using CircleCI"
56
categories: [getting-started]
67
order: 2
78
---

jekyll/_cci2/glossary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Glossary"
44
short-title: "Glossary"
5+
description: "Glossary for terms used within CircleCI"
56
categories: [reference]
67
order: 2
78
---

jekyll/_cci2/help-and-support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Help and Support"
44
short-title: "Help and Support"
5+
description: "A list of possible support options"
56
categories: [reference]
67
order: 3
78
---

jekyll/_cci2/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: classic-docs
33
title: "Welcome to CircleCI 2.0"
4+
description: "Landing page for CircleCI 2.0"
45
permalink: /2.0/
56
---
67

jekyll/_cci2/language-clojure.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: Clojure"
44
short-title: "Clojure"
5+
description: "Overview and sample config for a Clojure project"
56
categories: [language-guides]
67
order: 2
78
---

jekyll/_cci2/language-elixir.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: Elixir"
44
short-title: "Elixir"
5+
description: "Overview and sample config for an Elixir project"
56
categories: [language-guides]
67
order: 2
78
---

jekyll/_cci2/language-go.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: Go"
44
short-title: "Go"
5+
description: "Overview and sample config for a Go project"
56
categories: [language-guides]
67
order: 3
78
---

jekyll/_cci2/language-javascript.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: JavaScript"
44
short-title: "JavaScript"
5+
description: "Overview and sample config for a JavaScript project"
56
categories: [language-guides]
67
order: 4
78
---

jekyll/_cci2/language-php.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: PHP"
44
short-title: "PHP"
5+
description: "Overview and sample config for a PHP project"
56
categories: [language-guides]
67
order: 5
78
---

jekyll/_cci2/language-python.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: Python"
44
short-title: "Python"
5+
description: "Overview and sample config for a Python project"
56
categories: [language-guides]
67
order: 6
78
---

jekyll/_cci2/language-ruby.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Language Guide: Ruby"
44
short-title: "Ruby"
5+
description: "Overview and sample config for a Ruby project"
56
categories: [language-guides]
67
order: 7
78
---

jekyll/_cci2/local-jobs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Running Jobs Locally"
44
short-title: "Running Jobs Locally"
5+
description: "Why and how to run local jobs"
56
categories: [configuring-jobs]
67
order: 30
78
---

jekyll/_cci2/migrating-from-1-2.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Migrating from 1.0 to 2.0"
44
short-title: "Migrating from 1.0 to 2.0"
5+
description: "Why and how to migrate from CircleCI 1.0 to 2.0"
56
categories: [getting-started]
67
order: 15
78
---

jekyll/_cci2/parallelism-faster-jobs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Parallelism with CircleCI CLI"
44
short-title: "Parallelism for Faster Jobs"
5+
description: "How to run tests in parallel"
56
categories: [configuring-jobs]
67
order: 50
78
---

jekyll/_cci2/private-images.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Using Private Images and Docker Registries"
44
short-title: "Using Private Images"
5+
description: "How to use private images with the Remote Docker Environment"
56
categories: [docker]
67
order: 1
78
---

jekyll/_cci2/project-walkthrough.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: classic-docs
33
title: "Project Walkthrough"
44
short-title: "Project Walkthrough"
5+
description: "Tutorial and sample config for a Flask project in CircleCI 2.0"
56
categories: [getting-started]
67
order: 25
78
---
@@ -393,7 +394,7 @@ Now, create a `setup-heroku.sh` file in the `.circleci` folder and add the follo
393394
login $HEROKU_LOGIN
394395
password $HEROKU_API_KEY
395396
EOF
396-
397+
397398
# Add heroku.com to the list of known hosts
398399
ssh-keyscan -H heroku.com >> ~/.ssh/known_hosts
399400
```

0 commit comments

Comments
 (0)