From 28cb0aa81a8bbbc81084fbe0d24b613da60c8f41 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 28 Apr 2020 11:26:58 -0700 Subject: [PATCH] docs: Use consistent spelling of CircleCI. --- docs/contributing/code-reviewing.md | 2 +- docs/git/cloning.md | 6 +++--- docs/git/using.md | 5 +++-- docs/testing/linters.md | 4 ++-- tools/ci/production-install | 2 +- tools/commit-message-lint | 2 +- 6 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/contributing/code-reviewing.md b/docs/contributing/code-reviewing.md index f3bcb299e5..b7931986e2 100644 --- a/docs/contributing/code-reviewing.md +++ b/docs/contributing/code-reviewing.md @@ -73,7 +73,7 @@ this?". Good choices include in [#10618](https://github.com/zulip/zulip/pull/10618), browse to bottom and click the red X next to `c6044ee` to see the build jobs for that commit. You can see that there are 5 build jobs in total. - All the 5 jobs run in Circle CI. You can see what caused + All the 5 jobs run in CircleCI. You can see what caused the job to fail by clicking on the failed job. This will open up a page in the CI that has more details on why the job failed. For example [this](https://circleci.com/gh/zulip/zulip/16617) diff --git a/docs/git/cloning.md b/docs/git/cloning.md index 0442ed4b6b..4df8342008 100644 --- a/docs/git/cloning.md +++ b/docs/git/cloning.md @@ -103,7 +103,7 @@ first-time contributors][zulip-rtd-dev-first-time]. This step is optional, but recommended. -The Zulip Server project is configured to use [Circle CI][circle-ci] +The Zulip Server project is configured to use [CircleCI][circle-ci] to test and create builds upon each new commit and pull request. CircleCI is the primary CI that runs frontend and backend tests across a wide range of Ubuntu distributions. @@ -120,13 +120,13 @@ you make changes, you use a fast edit-refresh cycle running individual tests locally until your changes work. But then once you've gotten the tests you'd expect to be relevant to your changes working, push a branch to run the full test suite in CircleCI before -you create a pull request. While you wait for Circle CI jobs +you create a pull request. While you wait for CircleCI jobs to run, you can start working on your next task. When the tests finish, you can create a pull request that you already know passes the tests. ### Setup CircleCI -First, sign in to [Circle CI][circle-ci] with your GitHub account and authorize +First, sign in to [CircleCI][circle-ci] with your GitHub account and authorize CircleCI to access your GitHub account and repositories. Once you've logged in click on **Add Projects** in right sidebar. This will list all your GitHub repositories. Now goto the row of Zulip and click on **Set Up Project**. diff --git a/docs/git/using.md b/docs/git/using.md index d8fd882b83..5ac5d98243 100644 --- a/docs/git/using.md +++ b/docs/git/using.md @@ -125,8 +125,9 @@ Now you're ready to work on the issue or feature. ## Run linters and tests locally -In addition to having Circle CI run tests and linters each time you push a new -commit, you can also run them locally. See [testing](../testing/testing.md) for details. +In addition to having CircleCI run tests and linters each time you +push a new commit, you can also run them locally. See +[testing](../testing/testing.md) for details. ## Stage changes diff --git a/docs/testing/linters.md b/docs/testing/linters.md index 8651ed1417..c2fc8548c3 100644 --- a/docs/testing/linters.md +++ b/docs/testing/linters.md @@ -48,8 +48,8 @@ note are: * `--skip` and `--only`: Only run certain linters. * `-m`: Only check modified files. -Finally, you can rely on our Circle CI setup to run linters for you, but -it is good practice to run lint checks locally. +Finally, you can rely on our CircleCI setup to run linters for you, +but it is good practice to run lint checks locally. ```eval_rst .. important:: diff --git a/tools/ci/production-install b/tools/ci/production-install index a4eead6172..5faf1c2bd9 100755 --- a/tools/ci/production-install +++ b/tools/ci/production-install @@ -20,7 +20,7 @@ fi "$ZULIP_PATH"/scripts/setup/install --self-signed-cert --hostname 127.0.0.1 --email circleci@example.com cat >>/etc/zulip/settings.py <