diff --git a/Gemfile.lock b/Gemfile.lock index 0d6c57cccec..f5da74bd826 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -100,7 +100,7 @@ GEM listen (~> 3.0) json (2.3.1) kramdown (1.17.0) - libv8 (3.16.14.19) + libv8 (3.16.14.19.1) liquid (4.0.3) listen (3.0.8) rb-fsevent (~> 0.9, >= 0.9.4) diff --git a/README.md b/README.md index 077e5718f8f..36b86db9f3b 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,80 @@ -# About this repository [![Build Status](https://travis-ci.com/travis-ci/docs-travis-ci-com.svg?branch=master)](https://travis-ci.com/travis-ci/docs-travis-ci-com) +# About Travis CI Repository [![Build Status](https://travis-ci.com/travis-ci/docs-travis-ci-com.svg?branch=master)](https://travis-ci.com/travis-ci/docs-travis-ci-com) -This is the documentation site for Travis CI! () +This is the documentation site for [Travis CI!](https://docs.travis-ci.com/). +Follow this guide to learn how to add new documentation and how to update existing documentation. -## How to contribute +## Add Documentation -Fork the repository, read the rest of this README file and make some changes. -Once you're done with your changes send a pull request. Thanks! +The following are the steps to add documentation. -## How to check your edit before sending PR +1. Review the [Travis CI documentation guidelines](/STYLE.md). +1. Check existing documentation. Verify that the documentation does not already exist or look for related documentation that can be enhanced. +1. Determine proper placement. In the [Travis CI repository](https://github.com/travis-ci/docs-travis-ci-com/tree/master), browse to the *user* folder (or any other specific folder) and create a new branch. +1. Create a new file and add the new documentation files. +1. Ensure to insert the name and extension for the file. +1. Commit your changes and add a short message to describe your changes. +1. Test the changes locally to verify your edits. +1. Submit a pull request. Include a clear title and description of the proposed changes, and click “**Create pull request**.” -You can inspect how your edits will be reflected by the documentation site. Either by clicking on the Netlify preview link in your Pull Request or building the docs locally. +Thank you for your contribution! The Travis CI team will review the pull request and approve any necessary changes. -### Install dependencies +## Update Existing Documentation -1. Make sure you have Ruby and RubyGems installed. +If you see a page that needs to be updated or that can be improved, follow these steps to update Travis CI's existing documentation. -1. Install [bundler](http://bundler.io/): +1. Review the [Travis CI documentation guidelines](/STYLE.md). +1. Identify the Travis CI docs page that needs to be updated. +1. Click the “**Improve this page on GitHub**” button in the top right corner. +1. Once on GitHub, edit the relevant file. +1. Commit your changes. Name your branch, and click the “**Propose changes**” button. +1. Build the docs in a local environment to verify your edits. +1. Submit a pull request. Ensure a clear title and description of the proposed changes are added, and click “**Create pull request**.” + +Thank you for your contribution. The Travis CI team will review the pull request and approve any necessary changes. + + +## Build Local Environment + +You can inspect how the documentation site will reflect your edits. Follow the steps below to learn how to build your local environment and check all your edits before sending the pull request for approval. + +### Install Dependencies + +Follow the steps below to install dependencies. + +1. Ensure you have *Ruby* and *RubyGems* installed. + +1. Clone the [Travis CI docs](https://github.com/travis-ci/docs-travis-ci-com/tree/master) repository. + +1. Install [bundler](http://bundler.io/) as follows: ```sh-session $ gem install bundler ``` -1. Install application dependencies: +1. Next, install application dependencies: ```sh-session $ bundle install --binstubs ``` -### Generate documentation +### Generate Documentation -Run +To generate the documentation, run the following command: ```sh-session $ ./bin/jekyll build ``` +### Run the Application Server -### Run application server - -You are now ready to start your documentation site, using Jekyll or Puma. +You are ready to start your local documentation site using Jekyll or Puma. For documentation edits, Jekyll is sufficient. -#### Starting and inspecting edits with Jekyll +#### Edit with Jekyll + +To start and inspect your edits using Jekyll, follow the steps below: -1. Run Jekyll server: +1. Run the *Jekyll* server: ```sh-session $ ./bin/jekyll serve @@ -51,12 +82,12 @@ For documentation edits, Jekyll is sufficient. 1. Open [localhost:4000](http://localhost:4000/) in your browser. -#### Starting and inspecting edits with Puma +#### Edit with Puma -For more programmatical PRs (such as handling webhooks notification -via POST), Puma is necessary. +For more programmatical pull requests (such as handling webhooks notifications +via POST), Puma is necessary. To start and inspect your edits using Puma, follow the steps below: -1. Run Puma server: +1. Run the *Puma* server: ```sh-session $ ./bin/puma @@ -64,10 +95,10 @@ via POST), Puma is necessary. 1. Open [localhost:9292](http://localhost:9292/) in your browser. -### API V2 documentation +### API Documentation -API V2 (and 2.1) documentation is maintained in `slate/source` and is generated at build time from source. +All Travis CI API V2 (and 2.1) documentation is maintained in `slate/source` and generated from the source at build time. ## License -Distributed under the [MIT license](https://opensource.org/licenses/MIT); the same as other Travis CI projects. +Distributed under the [MIT license](https://opensource.org/licenses/MIT), like other Travis CI projects. diff --git a/STYLE.md b/STYLE.md index 2df480c6e02..e972d86259c 100644 --- a/STYLE.md +++ b/STYLE.md @@ -1,6 +1,6 @@ -# Travis CI documentation style guide +# Travis CI Documentation Style Guide -## Markdown and structure +## Markdown and Structure We're planning to lint the Markdown with [Coala.io][coala] and the [MarkdownBear][bear]. @@ -12,13 +12,13 @@ We'll be using a subset (TBD) of the full [list of checks][checks]. [checks]: https://github.com/coala/bear-docs/blob/master/docs/MarkdownBear.rst#settings "MarkdownBear checks" -We use Kramdown, with [GFM](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) codeblocks, and a few Kramdown related exceptions introduced with `{: }` such as class names for specific formatting of columns and notes. +We use Kramdown, with [GFM](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) code blocks, and a few Kramdown-related exceptions introduced with `{: }` such as class names for specific formatting of columns and notes. -### Headings +## Headings -For historical reasons, the top level heading in Jekyll markdown files is level 2 (##) not level 1 (#). +For historical reasons, the top-level heading in Jekyll's markdown files is level 2 (##), not level 1 (#). Only the page’s title is a level 1 heading. -We use ATX style headings, and do not use the optional closing hashes: +We use ATX-style headings and do not use the optional closing hashes: ```markdown ## This is an H2 @@ -28,16 +28,16 @@ We use ATX style headings, and do not use the optional closing hashes: #### This is an H4 ``` -We do not use underline style headings: +We do not use underlined style headings: ```markdown Do not use this style heading ============================= ``` -### Lists +## Lists -If you have long lists you can wrap them into 2 (`.column-2`) or 3 (`.column-3`) columns using one of the follow CSS classes after your list item: +If you have long lists, you can wrap them into 2 (`.column-2`) or 3 (`.column-3`) columns using one of the following CSS classes after your list item: ```css * long list item 1 @@ -45,21 +45,45 @@ If you have long lists you can wrap them into 2 (`.column-2`) or 3 (`.column-3`) {: .column-2 } ``` -#### In-page table of contents +## Links -All pages have tables of contents generated automatically from H2 and H3 +Make sure all links have titles: + +```markdown +The [link][example1] in the text + +[example1]: http://www.example.com "Example URL" +``` + +or + +```markdown +The [link](http://www.example.com "Example URL") in the text +``` + +When linking internal pages, use absolute paths and trailing slashes: `/user/languages/c/`. +You can link to headings and remember to remove special characters, for example: + +To link to "##Node.js Page," use `#nodejs-page`. + + +## In-page Options -To remove the TOC from a page add `no_toc: true` to the frontmatter. +### Notes, warnings, and blocks -### Note, warnings and blocks +Travis CI uses the blockquote symbol `>` for general-purpose notes and warnings. -We use the blockquote symbol `>` for general purpose notes and warnings. +See an example below: -#### Beta features +> Note: This feature is only available in Version 2.0. + +### Beta features Mark all beta features with a specially formatted note. Both the `> BETA` and the `{: .beta}` are required. +See an example below: + > BETA Awesome new feature that might not be enabled and is subject to change. {: .beta} @@ -68,38 +92,17 @@ the `{: .beta}` are required. Mark all alpha features with a specially formatted note. Both the `> ALPHA` and the `{: alpha}` are required. -> ALPHA Awesome new feature that might explode for extra fun. +> ALPHA: Awesome new feature that might explode for extra fun. {: .alpha} ### GUI -Make sure all references to items in a GUI match the case of the UI, and are marked with *asterisks*. - -### Links - -Make sure all links have titles: - -```markdown -The [link][example1] in the text - -[example1]: http://www.example.com "Example URL" -``` - -or - -```markdown -The [link](http://www.example.com "Example URL") in the text -``` - -When linking internal pages, use absolute paths and trailing slashes: `/user/languages/c/`. -You can link to headings, remember to remove special characters, for example: - -To link to "##Node.js Page" use `#nodejs-page`. +Ensure all references to items in a GUI match the case of the UI and are marked with *asterisks*. ### Code Inline -All function names, filenames, etc should be marked with `back-ticks`. +All function names, filenames, etc., should be marked with `back-ticks`. If you're talking about applications or services, only the actual command should be marked as code, not the name of the service: @@ -107,7 +110,7 @@ If you're talking about applications or services, only the actual command should ### Blockquotes / Notes / Warnings -As we have no use for blockquotes we use `>` to indicate notes and warnings: +As we have no use for blockquotes, we use `>` to indicate notes and warnings: ```markdown > Note this important info! @@ -131,16 +134,62 @@ This code is in .travis.yml ``` {: data-file=".travis.yml"} +### In-page table of contents + +All Travis CI pages have tables of contents generated automatically from H2 and H3 +Add `no_toc: true` to the frontmatter to remove the TOC from a page. -### Common misspellings and words to avoid +### Terminology +The following are some common misspellings and words to avoid - Always refer to *Travis CI* and never to Travis. ## Images +Add images inline-style with a brief description. + +To add an image, follow these steps: +1 Capture the image. +2 Save the image in the `images/` path. +3 Add the image to the documentation as follows: +![description text](image path or URL) + ### Screencapture gifs 1. Run a build (or whatever you are trying to capture), 2. Capture it with [licecap](https://www.cockos.com/licecap/). -3. Save the gif in `images/` +3. Save the gif in the following path: `images/` + + +## Documentation Template + +A basic template for contributing to new documentation pages or sections is as follows: + +```markdown +--- +title: “Insert Page Title” +layout: en + +--- + +Start your introduction here. Usually, an introduction is between one and three sentences. + +## Section Heading + +Section introduction sentence. + +* **Item1** - a group of *jobs* that run in sequence. +* **Item2** - a group of *jobs* that run in parallel as part of a sequential *build* process composed of multiple [stages](/user/build-stages/). +* **Item3** - an automated process that clones your repository into a virtual + environment and then carries out a series of *phases* such as compiling your + code, running tests, etc. +* **Item4** - the [sequential steps](/user/job-lifecycle/) + of a *job*. + +``` +{: data-file=".travis.yml"} + +The example above shows a paragraph with different formatting options. + +Check out the [Travis CI documentation](https://docs.travis-ci.com/) for more examples. diff --git a/_includes/deploy/opt_in.md b/_includes/deploy/opt_in.md index bfff233cb43..acfecf12730 100644 --- a/_includes/deploy/opt_in.md +++ b/_includes/deploy/opt_in.md @@ -1,12 +1,30 @@ -## How to opt in to v2 +## How to opt in to different deployment tooling versions -In order to use version `v2` of our deployment tooling, please add the +In order to use different version of our deployment tooling, please add the following to your `.travis.yml`: ```yaml deploy: provider: # ⋮ + dpl_version: # Optional, defaults to the latest stable version +``` +if you want to use the latest edge version of the deployment tooling: + +```yaml +deploy: + provider: + # ⋮ + edge: true +``` +if you want to use other edge version of the deployment tooling: + +```yaml +deploy: + provider: + # ⋮ + dpl_version: edge: true ``` + {: data-file=".travis.yml"} diff --git a/_includes/deploy/providers/anynines.md b/_includes/deploy/providers/anynines.md index 5b111deb742..abd299f3265 100644 --- a/_includes/deploy/providers/anynines.md +++ b/_includes/deploy/providers/anynines.md @@ -43,4 +43,4 @@ All options can be given as environment variables if prefixed with `ANYNINES_`. For example, `password` can be given as `ANYNINES_PASSWORD=`. -{% include deploy/secrets.md name="password" env_name="ANYNINES_PASSWORD" %} \ No newline at end of file +{% include deploy/secrets.md name="password" env_name="ANYNINES_PASSWORD" %} diff --git a/_includes/deploy/providers/bintray.md b/_includes/deploy/providers/bintray.md index 54b26afced0..995dc7e00ee 100644 --- a/_includes/deploy/providers/bintray.md +++ b/_includes/deploy/providers/bintray.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to Bintray is *stable**. +Support for deployments to Bintray is **stable**. ## Known options Use the following options to further configure the deployment. @@ -39,4 +39,4 @@ All options can be given as environment variables if prefixed with `BINTRAY_`. For example, `key` can be given as `BINTRAY_KEY=`. -{% include deploy/secrets.md name="key" env_name="BINTRAY_KEY" %} \ No newline at end of file +{% include deploy/secrets.md name="key" env_name="BINTRAY_KEY" %} diff --git a/_includes/deploy/providers/bluemixcloudfoundry.md b/_includes/deploy/providers/bluemixcloudfoundry.md index 03fcb9d95d8..3169a66aa56 100644 --- a/_includes/deploy/providers/bluemixcloudfoundry.md +++ b/_includes/deploy/providers/bluemixcloudfoundry.md @@ -19,7 +19,7 @@ deploy: ## Status -Support for deployments to Bluemix Cloud Foundry is *stable**. +Support for deployments to Bluemix Cloud Foundry is **stable**. ## Known options Use the following options to further configure the deployment. @@ -46,4 +46,4 @@ All options can be given as environment variables if prefixed with `CLOUDFOUNDRY For example, `password` can be given as `CLOUDFOUNDRY_PASSWORD=`. -{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %} \ No newline at end of file +{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %} diff --git a/_includes/deploy/providers/cargo.md b/_includes/deploy/providers/cargo.md index 7d2f622fdbe..d3809add71f 100644 --- a/_includes/deploy/providers/cargo.md +++ b/_includes/deploy/providers/cargo.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to Cargo is *stable**. +Support for deployments to Cargo is **stable**. ## Known options Use the following options to further configure the deployment. @@ -35,4 +35,4 @@ All options can be given as environment variables if prefixed with `CARGO_`. For example, `token` can be given as `CARGO_TOKEN=`. -{% include deploy/secrets.md name="token" env_name="CARGO_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="CARGO_TOKEN" %} diff --git a/_includes/deploy/providers/cloudformation.md b/_includes/deploy/providers/cloudformation.md index c4bea1d1447..0d965061622 100644 --- a/_includes/deploy/providers/cloudformation.md +++ b/_includes/deploy/providers/cloudformation.md @@ -19,7 +19,7 @@ deploy: ## Status -Support for deployments to AWS CloudFormation is *stable**. +Support for deployments to AWS CloudFormation is **stable**. ## Known options Use the following options to further configure the deployment. @@ -49,9 +49,9 @@ Use the following options to further configure the deployment. All options can be given as environment variables if prefixed with `AWS_` or `CLOUDFORMATION_`. -For example, `access_key_id` can be given as +For example, `access_key_id` can be given as -* `AWS_ACCESS_KEY_ID=` or +* `AWS_ACCESS_KEY_ID=` or * `CLOUDFORMATION_ACCESS_KEY_ID=` -{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/cloudfoundry.md b/_includes/deploy/providers/cloudfoundry.md index 5aea989d037..02f962189b4 100644 --- a/_includes/deploy/providers/cloudfoundry.md +++ b/_includes/deploy/providers/cloudfoundry.md @@ -19,7 +19,7 @@ deploy: ## Status -Support for deployments to Cloud Foundry is *stable**. +Support for deployments to Cloud Foundry is **stable**. ## Known options Use the following options to further configure the deployment. @@ -47,4 +47,4 @@ All options can be given as environment variables if prefixed with `CLOUDFOUNDRY For example, `password` can be given as `CLOUDFOUNDRY_PASSWORD=`. -{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %} \ No newline at end of file +{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %} diff --git a/_includes/deploy/providers/codedeploy.md b/_includes/deploy/providers/codedeploy.md index b4152f7a72a..2fbcdb82256 100644 --- a/_includes/deploy/providers/codedeploy.md +++ b/_includes/deploy/providers/codedeploy.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to AWS Code Deploy is *stable**. +Support for deployments to AWS Code Deploy is **stable**. ## Known options Use the following options to further configure the deployment. @@ -48,9 +48,9 @@ Use the following options to further configure the deployment. All options can be given as environment variables if prefixed with `AWS_` or `CODEDEPLOY_`. -For example, `access_key_id` can be given as +For example, `access_key_id` can be given as -* `AWS_ACCESS_KEY_ID=` or +* `AWS_ACCESS_KEY_ID=` or * `CODEDEPLOY_ACCESS_KEY_ID=` ## Interpolation variables @@ -86,4 +86,4 @@ For example: "Current build number: ${TRAVIS_BUILD_NUMBER}". See [here](/user/environment-variables/#default-environment-variables) for a list of default environment variables set. -{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/elasticbeanstalk.md b/_includes/deploy/providers/elasticbeanstalk.md index 795fb698da0..bf8dd54a596 100644 --- a/_includes/deploy/providers/elasticbeanstalk.md +++ b/_includes/deploy/providers/elasticbeanstalk.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to AWS Elastic Beanstalk is *stable**. +Support for deployments to AWS Elastic Beanstalk is **stable**. ## Known options Use the following options to further configure the deployment. @@ -45,9 +45,9 @@ Use the following options to further configure the deployment. All options can be given as environment variables if prefixed with `AWS_` or `ELASTIC_BEANSTALK_`. -For example, `access_key_id` can be given as +For example, `access_key_id` can be given as -* `AWS_ACCESS_KEY_ID=` or +* `AWS_ACCESS_KEY_ID=` or * `ELASTIC_BEANSTALK_ACCESS_KEY_ID=` -{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/firebase.md b/_includes/deploy/providers/firebase.md index 4f3f2465f6e..d6b412961c9 100644 --- a/_includes/deploy/providers/firebase.md +++ b/_includes/deploy/providers/firebase.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to Firebase is *stable**. +Support for deployments to Firebase is **stable**. ## Known options Use the following options to further configure the deployment. @@ -38,4 +38,4 @@ All options can be given as environment variables if prefixed with `FIREBASE_`. For example, `token` can be given as `FIREBASE_TOKEN=`. -{% include deploy/secrets.md name="token" env_name="FIREBASE_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="FIREBASE_TOKEN" %} diff --git a/_includes/deploy/providers/gae.md b/_includes/deploy/providers/gae.md index aafd000d8ed..93ba9235b45 100644 --- a/_includes/deploy/providers/gae.md +++ b/_includes/deploy/providers/gae.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to Google App Engine is *stable**. +Support for deployments to Google App Engine is **stable**. ## Known options Use the following options to further configure the deployment. diff --git a/_includes/deploy/providers/gcs.md b/_includes/deploy/providers/gcs.md index 65d6deb77ff..6d6e5ec6d22 100644 --- a/_includes/deploy/providers/gcs.md +++ b/_includes/deploy/providers/gcs.md @@ -27,7 +27,7 @@ deploy: ## Status -Support for deployments to Google Cloud Store is *stable**. +Support for deployments to Google Cloud Store is **stable**. ## Known options Use the following options to further configure the deployment. Either `key_file` or `access_key_id` and `secret_access_key` are required. @@ -55,4 +55,4 @@ All options can be given as environment variables if prefixed with `GCS_`. For example, `access_key_id` can be given as `GCS_ACCESS_KEY_ID=`. -{% include deploy/secrets.md name="access_key_id" env_name="GCS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="GCS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/heroku_api.md b/_includes/deploy/providers/heroku_api.md index e5cdbb95ee6..d7acd881a8b 100644 --- a/_includes/deploy/providers/heroku_api.md +++ b/_includes/deploy/providers/heroku_api.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to Heroku API is *stable**. +Support for deployments to Heroku API is **stable**. ## Known options Use the following options to further configure the deployment. @@ -36,4 +36,4 @@ All options can be given as environment variables if prefixed with `HEROKU_`. For example, `api_key` can be given as `HEROKU_API_KEY=`. -{% include deploy/secrets.md name="api_key" env_name="HEROKU_API_KEY" %} \ No newline at end of file +{% include deploy/secrets.md name="api_key" env_name="HEROKU_API_KEY" %} diff --git a/_includes/deploy/providers/lambda.md b/_includes/deploy/providers/lambda.md index d8e5045abce..7b1d720b45e 100644 --- a/_includes/deploy/providers/lambda.md +++ b/_includes/deploy/providers/lambda.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to AWS Lambda is *stable**. +Support for deployments to AWS Lambda is **stable**. ## Known options Use the following options to further configure the deployment. @@ -55,9 +55,9 @@ Use the following options to further configure the deployment. All options can be given as environment variables if prefixed with `AWS_` or `LAMBDA_`. -For example, `access_key_id` can be given as +For example, `access_key_id` can be given as -* `AWS_ACCESS_KEY_ID=` or +* `AWS_ACCESS_KEY_ID=` or * `LAMBDA_ACCESS_KEY_ID=` ## Interpolation variables @@ -93,4 +93,4 @@ For example: "Current build number: ${TRAVIS_BUILD_NUMBER}". See [here](/user/environment-variables/#default-environment-variables) for a list of default environment variables set. -{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/npm.md b/_includes/deploy/providers/npm.md index 6a45a813dac..c32c7a307e5 100644 --- a/_includes/deploy/providers/npm.md +++ b/_includes/deploy/providers/npm.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to npm is *stable**. +Support for deployments to npm is **stable**. ## Known options Use the following options to further configure the deployment. @@ -42,4 +42,4 @@ All options can be given as environment variables if prefixed with `NPM_`. For example, `api_token` can be given as `NPM_API_TOKEN=`. -{% include deploy/secrets.md name="api_token" env_name="NPM_API_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="api_token" env_name="NPM_API_TOKEN" %} diff --git a/_includes/deploy/providers/openshift.md b/_includes/deploy/providers/openshift.md index b066ffdd4e0..550d9a44d21 100644 --- a/_includes/deploy/providers/openshift.md +++ b/_includes/deploy/providers/openshift.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to OpenShift is *stable**. +Support for deployments to OpenShift is **stable**. ## Known options Use the following options to further configure the deployment. @@ -39,4 +39,4 @@ All options can be given as environment variables if prefixed with `OPENSHIFT_`. For example, `token` can be given as `OPENSHIFT_TOKEN=`. -{% include deploy/secrets.md name="token" env_name="OPENSHIFT_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="OPENSHIFT_TOKEN" %} diff --git a/_includes/deploy/providers/opsworks.md b/_includes/deploy/providers/opsworks.md index 52884fa8cc5..f25a64cfb71 100644 --- a/_includes/deploy/providers/opsworks.md +++ b/_includes/deploy/providers/opsworks.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to AWS OpsWorks is *stable**. +Support for deployments to AWS OpsWorks is **stable**. ## Known options Use the following options to further configure the deployment. @@ -43,9 +43,9 @@ Use the following options to further configure the deployment. All options can be given as environment variables if prefixed with `AWS_` or `OPSWORKS_`. -For example, `access_key_id` can be given as +For example, `access_key_id` can be given as -* `AWS_ACCESS_KEY_ID=` or +* `AWS_ACCESS_KEY_ID=` or * `OPSWORKS_ACCESS_KEY_ID=` -{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/pages_git.md b/_includes/deploy/providers/pages_git.md index b2fa6b22c66..f39d2027440 100644 --- a/_includes/deploy/providers/pages_git.md +++ b/_includes/deploy/providers/pages_git.md @@ -24,7 +24,7 @@ deploy: ## Status -Support for deployments to GitHub Pages is *stable**. +Support for deployments to GitHub Pages is **stable**. ## Known options Use the following options to further configure the deployment. Either `token` or `deploy_key` are required. @@ -56,9 +56,9 @@ Use the following options to further configure the deployment. Either `token` or All options can be given as environment variables if prefixed with `GITHUB_` or `PAGES_`. -For example, `token` can be given as +For example, `token` can be given as -* `GITHUB_TOKEN=` or +* `GITHUB_TOKEN=` or * `PAGES_TOKEN=` ## Interpolation variables @@ -91,4 +91,4 @@ For example: "Current build number: ${TRAVIS_BUILD_NUMBER}". See [here](/user/environment-variables/#default-environment-variables) for a list of default environment variables set. -{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %} diff --git a/_includes/deploy/providers/pypi.md b/_includes/deploy/providers/pypi.md index 49cb9478df1..5140bd2d1a9 100644 --- a/_includes/deploy/providers/pypi.md +++ b/_includes/deploy/providers/pypi.md @@ -17,7 +17,7 @@ deploy: ## Status -Support for deployments to PyPI is *stable**. +Support for deployments to PyPI is **stable**. ## Known options Use the following options to further configure the deployment. @@ -46,4 +46,4 @@ All options can be given as environment variables if prefixed with `PYPI_`. For example, `password` can be given as `PYPI_PASSWORD=`. -{% include deploy/secrets.md name="password" env_name="PYPI_PASSWORD" %} \ No newline at end of file +{% include deploy/secrets.md name="password" env_name="PYPI_PASSWORD" %} diff --git a/_includes/deploy/providers/releases.md b/_includes/deploy/providers/releases.md index 115238b7d91..24c0b8e0506 100644 --- a/_includes/deploy/providers/releases.md +++ b/_includes/deploy/providers/releases.md @@ -25,7 +25,7 @@ deploy: ## Status -Support for deployments to GitHub Releases is *stable**. +Support for deployments to GitHub Releases is **stable**. ## Known options Use the following options to further configure the deployment. Either `token` or `username` and `password` are required. @@ -55,9 +55,9 @@ Use the following options to further configure the deployment. Either `token` or All options can be given as environment variables if prefixed with `GITHUB_` or `RELEASES_`. -For example, `token` can be given as +For example, `token` can be given as -* `GITHUB_TOKEN=` or +* `GITHUB_TOKEN=` or * `RELEASES_TOKEN=` -{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %} diff --git a/_includes/deploy/providers/rubygems.md b/_includes/deploy/providers/rubygems.md index 6cd276abc56..c8d41a71c81 100644 --- a/_includes/deploy/providers/rubygems.md +++ b/_includes/deploy/providers/rubygems.md @@ -25,7 +25,7 @@ deploy: ## Status -Support for deployments to Rubygems is *stable**. +Support for deployments to Rubygems is **stable**. ## Known options Use the following options to further configure the deployment. Either `api_key` or `username` and `password` are required. @@ -49,4 +49,4 @@ All options can be given as environment variables if prefixed with `RUBYGEMS_`. For example, `api_key` can be given as `RUBYGEMS_API_KEY=`. -{% include deploy/secrets.md name="api_key" env_name="RUBYGEMS_API_KEY" %} \ No newline at end of file +{% include deploy/secrets.md name="api_key" env_name="RUBYGEMS_API_KEY" %} diff --git a/_includes/deploy/providers/s3.md b/_includes/deploy/providers/s3.md index edbd1ffd3a6..2b169c12657 100644 --- a/_includes/deploy/providers/s3.md +++ b/_includes/deploy/providers/s3.md @@ -18,7 +18,7 @@ deploy: ## Status -Support for deployments to AWS S3 is *stable**. +Support for deployments to AWS S3 is **stable**. ## Known options Use the following options to further configure the deployment. @@ -54,9 +54,9 @@ Use the following options to further configure the deployment. All options can be given as environment variables if prefixed with `AWS_` or `S3_`. -For example, `access_key_id` can be given as +For example, `access_key_id` can be given as -* `AWS_ACCESS_KEY_ID=` or +* `AWS_ACCESS_KEY_ID=` or * `S3_ACCESS_KEY_ID=` -{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} \ No newline at end of file +{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %} diff --git a/_includes/deploy/providers/script.md b/_includes/deploy/providers/script.md index 26b6fa47ed4..3ce13b59ad4 100644 --- a/_includes/deploy/providers/script.md +++ b/_includes/deploy/providers/script.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to Script is *stable**. +Support for deployments to Script is **stable**. ## Known options Use the following options to further configure the deployment. diff --git a/_includes/deploy/providers/snap.md b/_includes/deploy/providers/snap.md index 3aa1637d95b..658053d94e9 100644 --- a/_includes/deploy/providers/snap.md +++ b/_includes/deploy/providers/snap.md @@ -16,7 +16,7 @@ deploy: ## Status -Support for deployments to Snap is *stable**. +Support for deployments to Snap is **stable**. ## Known options Use the following options to further configure the deployment. @@ -36,4 +36,4 @@ All options can be given as environment variables if prefixed with `SNAP_`. For example, `token` can be given as `SNAP_TOKEN=`. -{% include deploy/secrets.md name="token" env_name="SNAP_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="SNAP_TOKEN" %} diff --git a/_includes/deploy/providers/surge.md b/_includes/deploy/providers/surge.md index 92b7c435eb1..350f8da9f7d 100644 --- a/_includes/deploy/providers/surge.md +++ b/_includes/deploy/providers/surge.md @@ -17,7 +17,7 @@ deploy: ## Status -Support for deployments to Surge is *stable**. +Support for deployments to Surge is **stable**. ## Known options Use the following options to further configure the deployment. @@ -38,4 +38,4 @@ All options can be given as environment variables if prefixed with `SURGE_`. For example, `token` can be given as `SURGE_TOKEN=`. -{% include deploy/secrets.md name="token" env_name="SURGE_TOKEN" %} \ No newline at end of file +{% include deploy/secrets.md name="token" env_name="SURGE_TOKEN" %} diff --git a/_includes/enterprise_sidebar.html b/_includes/enterprise_sidebar.html index 882d51cab3b..10ebd663440 100644 --- a/_includes/enterprise_sidebar.html +++ b/_includes/enterprise_sidebar.html @@ -1,31 +1,4 @@