codesleuth / circleci-docs

CircleCI documentation for v1.0

CircleCI Documentation

This is the public repository for https://circleci.com/docs/, a static website generated by Jekyll. If you find any errors in our docs or have suggestions, please follow our Contributing Guide to submit an issue or pull request.

For minor changes like typos, you can click Suggest an edit to this page, located at the bottom of each article. This will take you to the source file on GitHub, where you can submit a pull request for your change through the UI.

For larger edits or new articles, you'll want to set up a local environment for editing. You'll need to fork this repository, clone the fork to your machine, then choose how to set up your local environment.

If you already have a stable Ruby environment and feel comfortable installing dependencies, follow our Jekyll guide. Otherwise, you can follow our Vagrant guide to set up a clean environment with all the project's neccessary dependencies.

If you have a question or need help debugging, please head to CircleCI Discuss where our support team will help you out.

License Information

Documentation (guides, references, and associated images) is licensed as Creative Commons Attribution-NonCommercial-ShareAlike CC BY-NC-SA. The full license can be found here, and the human-readable summary here.

Everything in this repository not covered above is licensed under the included MIT license.