# Documentation

**URL:** https://discuss.circleci.com/c/resources/docs/43.md

[Latest](https://discuss.circleci.com/latest.md) · [Categories](https://discuss.circleci.com/categories.md) · [Tags](https://discuss.circleci.com/tags.md)

---

## [About the Documentation category](https://discuss.circleci.com/t/about-the-documentation-category/3889)

<div class="topic-metadata">

**Author:** [@FelicianoTech](https://discuss.circleci.com/u/FelicianoTech)\
**Replies:** 0\
**Last updated:** [May 9, 2016, 8:35pm UTC](https://discuss.circleci.com/t/about-the-documentation-category/3889 "2016-05-09T20:35:19Z")

</div>

This is where we can discuss CircleCI Documentation "Docs". This does not replace GitHub, which is where CircleCI Docs is hosted. See the full description below and do's and don'ts for posting here vs GitHub. CircleCI …

---

## [CircleCI docs site: menus & search non-functional in google chrome v150.x](https://discuss.circleci.com/t/circleci-docs-site-menus-search-non-functional-in-google-chrome-v150-x/54795)

<div class="topic-metadata">

**Author:** [@dawnmist](https://discuss.circleci.com/u/dawnmist)\
**Replies:** 2\
**Last updated:** [July 25, 2026, 3:43am UTC](https://discuss.circleci.com/t/circleci-docs-site-menus-search-non-functional-in-google-chrome-v150-x/54795 "2026-07-25T03:43:56Z")

</div>

I am trying to access documentation on using circleci. When I navigate to the docs site in Google Chrome, I can only access the pages within the first submenu group. Clicking on menu toggle buttons for any menu group d…

---

## [Missing topic about how to get artifacts from a job](https://discuss.circleci.com/t/missing-topic-about-how-to-get-artifacts-from-a-job/54749)

<div class="topic-metadata">

**Author:** [@ggetchev](https://discuss.circleci.com/u/ggetchev)\
**Replies:** 1\
**Last updated:** [July 1, 2026, 9:37pm UTC](https://discuss.circleci.com/t/missing-topic-about-how-to-get-artifacts-from-a-job/54749 "2026-07-01T21:37:50Z")

</div>

In the API v2 documentation webpage, there is no topic in the Jobs section, explaining how to get the artifacts from a job. Is this intentional or a accidental miss?

---

## [Documentation for circleci-agent](https://discuss.circleci.com/t/documentation-for-circleci-agent/36594)

<div class="topic-metadata">

**Author:** [@OPeyrusse](https://discuss.circleci.com/u/OPeyrusse)\
**Replies:** 4\
**Last updated:** [October 15, 2025, 4:45pm UTC](https://discuss.circleci.com/t/documentation-for-circleci-agent/36594 "2025-10-15T16:45:34Z")

</div>

The documentation only mentions one use of circleci-agent, being circleci-agent step halt \[1\]. Because this call is made of 2 params “step” and “halt”, I was wondering if any other values for those parameters were allow…

---

## [New docs site is live!](https://discuss.circleci.com/t/new-docs-site-is-live/53906)

<div class="topic-metadata">

**Author:** [@rosie](https://discuss.circleci.com/u/rosie)\
**Replies:** 0\
**Last updated:** [August 6, 2025, 8:07pm UTC](https://discuss.circleci.com/t/new-docs-site-is-live/53906 "2025-08-06T20:07:44Z")

</div>

New and improved docs site We’re excited to launch our revamped documentation site at https://circleci.com/docs with better navigation, organization, and layout. What’s new: Improved navigation structure Version swit…

---

## [Sunsetting Japanese Documentation pages - April 1, 2025](https://discuss.circleci.com/t/sunsetting-japanese-documentation-pages-april-1-2025/53008)

<div class="topic-metadata">

**Author:** [@sebastian-lerner](https://discuss.circleci.com/u/sebastian-lerner)\
**Replies:** 0\
**Last updated:** [March 27, 2025, 8:16pm UTC](https://discuss.circleci.com/t/sunsetting-japanese-documentation-pages-april-1-2025/53008 "2025-03-27T20:16:35Z")

</div>

Effective April 1, 2025, all Japanese versions of our public documentation will be removed from the site. The language switcher will also be discontinued. Please use the English version of these pages for the most accur…

---

## [Triggers in circleci-config-sdk](https://discuss.circleci.com/t/triggers-in-circleci-config-sdk/51547)

<div class="topic-metadata">

**Author:** [@danfernand](https://discuss.circleci.com/u/danfernand)\
**Replies:** 0\
**Last updated:** [July 26, 2024, 11:25pm UTC](https://discuss.circleci.com/t/triggers-in-circleci-config-sdk/51547 "2024-07-26T23:25:55Z")

</div>

Our organization is using @circleci/circleci-config-sdk and we are implementing or first CRON job. Don’t see anywhere in the sdk any references to triggers or cron

---

## [How do I purchase more credits?](https://discuss.circleci.com/t/how-do-i-purchase-more-credits/47350)

<div class="topic-metadata">

**Author:** [@seanmorris](https://discuss.circleci.com/u/seanmorris)\
**Replies:** 2\
**Last updated:** [March 6, 2023, 5:46pm UTC](https://discuss.circleci.com/t/how-do-i-purchase-more-credits/47350 "2023-03-06T17:46:52Z")

</div>

I ran out of credits on my ‘scale’ plan and can’t find anywhere to buy more. The documentations says they payment will be applied automatically but nothing has happened in nearly 24 hours.

---

## [Modify status badge label](https://discuss.circleci.com/t/modify-status-badge-label/38247)

<div class="topic-metadata">

**Author:** [@edgarriba](https://discuss.circleci.com/u/edgarriba)\
**Replies:** 2\
**Last updated:** [February 2, 2023, 8:12am UTC](https://discuss.circleci.com/t/modify-status-badge-label/38247 "2023-02-02T08:12:53Z")

</div>

Hi! I was trying to modify the label of the status badge for .rst files. e.g. the default label is circleci and I want to change by something like tests-\<my\_label\> I checked the docs: https://circleci.com/docs/2.0/sta…

---

## [Node image docs showing browser image tags](https://discuss.circleci.com/t/node-image-docs-showing-browser-image-tags/45759)

<div class="topic-metadata">

**Author:** [@dumbledad](https://discuss.circleci.com/u/dumbledad)\
**Replies:** 1\
**Last updated:** [December 20, 2022, 10:00pm UTC](https://discuss.circleci.com/t/node-image-docs-showing-browser-image-tags/45759 "2022-12-20T22:00:20Z")

</div>

Looking at cimg/node - CircleCI there’s a table headed Image Tags which I would expect to contain entries like 16.18.0-node but instead it contains entries like 16.18.0-browser. Is that right?

---

## [Does circle ci charges credits on the idle time in parallel mode](https://discuss.circleci.com/t/does-circle-ci-charges-credits-on-the-idle-time-in-parallel-mode/43355)

<div class="topic-metadata">

**Author:** [@mcnawapon](https://discuss.circleci.com/u/mcnawapon)\
**Replies:** 2\
**Last updated:** [September 30, 2022, 9:09am UTC](https://discuss.circleci.com/t/does-circle-ci-charges-credits-on-the-idle-time-in-parallel-mode/43355 "2022-09-30T09:09:14Z")

</div>

I’m seeing that my parallelism workflows have a huge idle time. Not sure if Circle CI charges credits on the idle time or not. I have looked through the doc and found nothing on this topic. The example in the doc stat…

---

## [Get all projects within an organization](https://discuss.circleci.com/t/get-all-projects-within-an-organization/44414)

<div class="topic-metadata">

**Author:** [@md\_nasim](https://discuss.circleci.com/u/md_nasim)\
**Replies:** 3\
**Last updated:** [June 13, 2022, 1:51pm UTC](https://discuss.circleci.com/t/get-all-projects-within-an-organization/44414 "2022-06-13T13:51:12Z")

</div>

How to get all projects within an organization in version 2?

---

## [CircleCI 新機能に関する情報(2021)](https://discuss.circleci.com/t/circleci-2021/41262)

<div class="topic-metadata">

**Author:** [@Masahiko](https://discuss.circleci.com/u/Masahiko)\
**Replies:** 0\
**Last updated:** [September 17, 2021, 1:46am UTC](https://discuss.circleci.com/t/circleci-2021/41262 "2021-09-17T01:46:07Z")

</div>

CircleCIの新機能に関する日本語の情報をCircleCI に関する最新情報 - CircleCIに合わせてまとめました。タイトルをクリックすると最新情報(Changelog)のページにジャンプします。 新機能のリクエストや、ほかのユーザーがどのような新機能(feature request)をリクエストしているかの一覧、および賛成の投票、CircleCIでの検討や対応状況は、CircleCI Ideas(英語)をご覧ください。 合…

---

## [Understanding Dart example in docs](https://discuss.circleci.com/t/understanding-dart-example-in-docs/41124)

<div class="topic-metadata">

**Author:** [@happy-san](https://discuss.circleci.com/u/happy-san)\
**Replies:** 3\
**Last updated:** [September 3, 2021, 1:40pm UTC](https://discuss.circleci.com/t/understanding-dart-example-in-docs/41124 "2021-09-03T13:40:58Z")

</div>

Hey community, I’ve tried looking what exactly /bin/bash --login -eo pipefail this code from the example does but couldn’t find anything. Could you direct me to an article or explain what it does? Thanks. commands: …

---

## [Circleci Webhook Secret token decryption or validation](https://discuss.circleci.com/t/circleci-webhook-secret-token-decryption-or-validation/40979)

<div class="topic-metadata">

**Author:** [@fmc100](https://discuss.circleci.com/u/fmc100)\
**Replies:** 1\
**Last updated:** [August 20, 2021, 2:49am UTC](https://discuss.circleci.com/t/circleci-webhook-secret-token-decryption-or-validation/40979 "2021-08-20T02:49:36Z")

</div>

There is nothing in the docs about how I would validate the secret token from a circleci webhook. Currently, when you enter one it adds a header to the request Circleci-Signature v1=\*\*\*\*\*\*\*\*\*. I have no idea how to val…

---

## [Mistake or outdated documentation?](https://discuss.circleci.com/t/mistake-or-outdated-documentation/40861)

<div class="topic-metadata">

**Author:** [@bananas](https://discuss.circleci.com/u/bananas)\
**Replies:** 1\
**Last updated:** [August 5, 2021, 11:11am UTC](https://discuss.circleci.com/t/mistake-or-outdated-documentation/40861 "2021-08-05T11:11:42Z")

</div>

I’m trying to use an example from the docs and getting a linter warning. Am I doing anything wrong? https://circleci.com/docs/2.0/configuration-reference/#logic-statement-examples

---

## [CircleCI 日本語ドキュメント 追加・更新](https://discuss.circleci.com/t/circleci/37835)

<div class="topic-metadata">

**Author:** [@Masahiko](https://discuss.circleci.com/u/Masahiko)\
**Replies:** 6\
**Last updated:** [December 17, 2020, 4:57am UTC](https://discuss.circleci.com/t/circleci/37835 "2020-12-17T04:57:41Z")

</div>

CircleCI 日本語ドキュメント(https://circleci.com/docs/ja/) の追加・更新情報をこちらでお知らせいたします。

---

## [Doc problem](https://discuss.circleci.com/t/doc-problem/31018)

<div class="topic-metadata">

**Author:** [@artgoldberg](https://discuss.circleci.com/u/artgoldberg)\
**Replies:** 1\
**Last updated:** [July 22, 2019, 11:56pm UTC](https://discuss.circleci.com/t/doc-problem/31018 "2019-07-22T23:56:25Z")

</div>

The link behind " read-write deployment key." doesn’t go to the right place. The link should be https://circleci.com/docs/2.0/gh-bb-integration/#deployment-keys-and-user-keys

---

## [SSH debugging documentation is incorrect](https://discuss.circleci.com/t/ssh-debugging-documentation-is-incorrect/30312)

<div class="topic-metadata">

**Author:** [@deeTEEcee](https://discuss.circleci.com/u/deeTEEcee)\
**Replies:** 2\
**Last updated:** [May 16, 2019, 9:04pm UTC](https://discuss.circleci.com/t/ssh-debugging-documentation-is-incorrect/30312 "2019-05-16T21:04:16Z")

</div>

This is what I read in https://circleci.com/docs/2.0/ssh-access-jobs/: " The build VM will remain available for 10 minutes after the build finishes running and then automatically shut down. (Or you can cancel it.)" Wh…

---

## [Engineering Productivity Metrics Questions](https://discuss.circleci.com/t/engineering-productivity-metrics-questions/28411)

<div class="topic-metadata">

**Author:** [@jgeek](https://discuss.circleci.com/u/jgeek)\
**Replies:** 1\
**Last updated:** [March 2, 2019, 8:03pm UTC](https://discuss.circleci.com/t/engineering-productivity-metrics-questions/28411 "2019-03-02T20:03:11Z")

</div>

I am trying to calculate engineering metrics for our enterprise product team based on the report published by circleci here. I have a few questions when I tried to calculate the metrics for us. They are detailed as below …

---

## [Docs Meeting Tuesdays at 10:30am PT](https://discuss.circleci.com/t/docs-meeting-tuesdays-at-10-30am-pt/20326)

<div class="topic-metadata">

**Author:** [@michelle-luna](https://discuss.circleci.com/u/michelle-luna)\
**Replies:** 17\
**Last updated:** [July 13, 2018, 11:32pm UTC](https://discuss.circleci.com/t/docs-meeting-tuesdays-at-10-30am-pt/20326 "2018-07-13T23:32:13Z")

</div>

Hi all, I’m Michelle Luna, heading up the docs at CircleCI. You are invited to join our first public docs meeting (aka docs party!) next week, Tuesday March 6th at 10amPT on google hangouts here: The goal is to introdu…

---

## [Is it mistake in "How to Build a Docker Image on CircleCI 2.0"?](https://discuss.circleci.com/t/is-it-mistake-in-how-to-build-a-docker-image-on-circleci-2-0/21262)

<div class="topic-metadata">

**Author:** [@junpayment](https://discuss.circleci.com/u/junpayment)\
**Replies:** 1\
**Last updated:** [April 5, 2018, 5:41pm UTC](https://discuss.circleci.com/t/is-it-mistake-in-how-to-build-a-docker-image-on-circleci-2-0/21262 "2018-04-05T17:41:45Z")

</div>

I read this article. It’s very helpful for me to build new CI environment on Docker in Docker! But I think I found a mistake about a example config.yml. - restore\_cache: keys: - v1-{{ .B…

---

## [Can't add a user](https://discuss.circleci.com/t/cant-add-a-user/11576)

<div class="topic-metadata">

**Author:** [@jowolf](https://discuss.circleci.com/u/jowolf)\
**Replies:** 7\
**Last updated:** [December 15, 2017, 7:45pm UTC](https://discuss.circleci.com/t/cant-add-a-user/11576 "2017-12-15T19:45:20Z")

</div>

I'd like to add a user to access our builds, she's already allowed to on Github. But when I select "Team" on the left in the web app, it says: "Get started by selecting your organization Select your GitHub organizati…

---

## [How to create an artifact as text to be displayed in "Artifacts" tab?](https://discuss.circleci.com/t/how-to-create-an-artifact-as-text-to-be-displayed-in-artifacts-tab/17986)

<div class="topic-metadata">

**Author:** [@andrew-chiz-muzychuk](https://discuss.circleci.com/u/andrew-chiz-muzychuk)\
**Replies:** 0\
**Last updated:** [November 9, 2017, 9:12pm UTC](https://discuss.circleci.com/t/how-to-create-an-artifact-as-text-to-be-displayed-in-artifacts-tab/17986 "2017-11-09T21:12:40Z")

</div>

I want to output two sentences after successful build. I need to parse build output, copy text from it and past into Artifact’s tab. Is it possible?

---

## [Documentation inconsistency about v2 config files](https://discuss.circleci.com/t/documentation-inconsistency-about-v2-config-files/12919)

<div class="topic-metadata">

**Author:** [@robertoestivill](https://discuss.circleci.com/u/robertoestivill)\
**Replies:** 2\
**Last updated:** [May 29, 2017, 8:52am UTC](https://discuss.circleci.com/t/documentation-inconsistency-about-v2-config-files/12919 "2017-05-29T08:52:22Z")

</div>

This article indicates that the config.yml for circle v2 should be in the directory .circleci/ while this other article indicates that the directory should be .circle/ Even if both are supported, I believe it would be …

---

## [STUB a server for Webhook response in CIRCLE-CI](https://discuss.circleci.com/t/stub-a-server-for-webhook-response-in-circle-ci/11890)

<div class="topic-metadata">

**Author:** [@meetme2meat](https://discuss.circleci.com/u/meetme2meat)\
**Replies:** 1\
**Last updated:** [May 11, 2017, 8:18pm UTC](https://discuss.circleci.com/t/stub-a-server-for-webhook-response-in-circle-ci/11890 "2017-05-11T20:18:25Z")

</div>

We are currently building our integration test. One of our test demand that we expect out test expect to receive (a callback response) from one of our services. Stuff look like this describe 'Integration Test' do be…

---

## [Newbie - Completely confused!](https://discuss.circleci.com/t/newbie-completely-confused/8271)

<div class="topic-metadata">

**Author:** [@GiacomoLaw](https://discuss.circleci.com/u/GiacomoLaw)\
**Replies:** 6\
**Last updated:** [December 13, 2016, 9:04pm UTC](https://discuss.circleci.com/t/newbie-completely-confused/8271 "2016-12-13T21:04:46Z")

</div>

I have checked out the documentation, but am still stumped. If someone could explain it to me like I am a three year old, I would love it. I am using CircleCl in this repo: https://github.com/IF-Apps/IF-Charts Along w…

---

## [Lost in the documentation](https://discuss.circleci.com/t/lost-in-the-documentation/10257)

<div class="topic-metadata">

**Author:** [@jknurek](https://discuss.circleci.com/u/jknurek)\
**Replies:** 1\
**Last updated:** [February 22, 2017, 1:41am UTC](https://discuss.circleci.com/t/lost-in-the-documentation/10257 "2017-02-22T01:41:13Z")

</div>

In the basic configuration doc, https://circleci.com/docs/1.0/configuration/ there is the line CircleCI supports a large number of databases and other services. Where is that list? What other services? How do I know…

---

## [CircleCI not triggering any build or PR hook \[SOLVED\]](https://discuss.circleci.com/t/circleci-not-triggering-any-build-or-pr-hook-solved/10331)

<div class="topic-metadata">

**Author:** [@rodrigopivi](https://discuss.circleci.com/u/rodrigopivi)\
**Replies:** 3\
**Last updated:** [February 14, 2017, 7:54pm UTC](https://discuss.circleci.com/t/circleci-not-triggering-any-build-or-pr-hook-solved/10331 "2017-02-14T19:54:22Z")

</div>

I have a project goldfingr/server and circle ci only worked when i triggered a manual build, but it can't get any commit updates (so no build is triggered automatically, and i can only trigger builds for old commits, see…

---

## [Your voice needed: help us restructure our docs](https://discuss.circleci.com/t/your-voice-needed-help-us-restructure-our-docs/3922)

<div class="topic-metadata">

**Author:** [@FelicianoTech](https://discuss.circleci.com/u/FelicianoTech)\
**Replies:** 3\
**Last updated:** [November 17, 2016, 1:46pm UTC](https://discuss.circleci.com/t/your-voice-needed-help-us-restructure-our-docs/3922 "2016-11-17T13:46:36Z")

</div>

\[CircleCI Docs PSA\] Hey everyone, We're always looking for ways to make CircleCI docs better. In fact, you may have read that we recently open-sourced docs, which we’re very excited about since it allows us to more q…

[Next page](https://discuss.circleci.com/c/resources/docs/43.md?page=1)
