Thank you for your interest in contributing to the CircleCI documentation.
There is never enough time to do everything we want to do. So, we prioritize issues according to the following four categories, in decreasing importance:
- Correct: documentation should be accurate.
- Current: documentation should be up-to-date.
- Consistent: documentation should not conflict with itself.
- Clear: documentation should be clear.
These values apply to both new and existing documentation.
We welcome all contributions to CircleCI documentation. These contributions come in two forms: issues and pull requests.
If you spot anything that conflicts with our values, you can create a GitHub Issue. This is a great way to give us specific feedback. Refer to the GitHub Issues Workflow wiki page for more information.
If you feel motivated, you can make documentation changes and submit a pull request.
For minor changes like typos, click "Suggest an edit to this page", located at the bottom of each document. This will take you to the source file on GitHub, where you can submit a pull request for your changes.
For larger edits or new documents, you can choose to edit docs locally. When you are satisfied with your changes, create a pull request from your branch by following GitHub's guide.
Regardless of the size of your change, do read through our Style Guide.
Please note that at this time, we cannot accept any articles or examples that require the use of third-party tools (such as third-party orbs) for maintenance and security reasons.
Pull request titles should be descriptive enough for reviewers to understand what is being changed. Some ways of doing this are better than others:
| Original Pull Request Title | Better Title |
|---|---|
| Updating file.md | Indicate support for environment variables in context paths |
| Sidebar changes | Move Deployment to its own navigation section for better organization |
Every pull request should have a description that explains why the change is being made. The description adds context that is critical for reviewers when giving feedback.
For more tips, see GitHub's blog entry on how to write the perfect pull request.
If you want to submit a pull request to update the docs, you will need to make a fork of this repo and clone it.
Currently all CircleCI docs are located in circleci-docs/jekyll/_cci2.
-
Create a branch and switch to it:
git checkout -b <branch-name> -
Add or modify Asciidoc and Markdown files in these directories according to our style guide.
-
When you are happy with your changes, commit them with a message summarizing what you did:
git commit -am "commit message" -
Push your branch up:
git push origin <branch-name>
New articles can be added to the jekyll/_cci2 directory in this repo.
We are slowly converting all oue content over to the Asciidoc format. So all new pages should be submitted in Asciidoc.
When you make a new article, you will need to add some document attributes and front matter. These contains metadata about the article you are writing and are required so everything works on our site.
Document attributes and Front matter for our docs will look something like:
---
version:
- Server v4.x
- Admin
---
= Page title
:page-layout: classic-docs
:page-liquid:
:page-description: A short description of the content on the page.
page-layout and the page title are the only required variables. page-layout associates an HTML layout with the page, classic-docs is used across our docs. title will appear at the top of your article.
The Docker tag list for convenience images, located in ./jekyll/_cci2/circleci-images.md, is dynamically updated during a CircleCI build.
There is usually no need to touch this.
If you would like to see an updated list generated locally however, you can do so by running ./scripts/pull-docker-image-tags.sh from the root of this repo.
Note that you will need the command-line tool jq installed.