-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New page for Chunk flaky test fix #9614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
@rosieyohannan Throughout the doc, are we going with “CircleCI Chunk” or “CircleCI’s Chunk”? Either way, should we just call it Chunk, and just Use CircleCI's Chunk for the first 1 or 2 occurrences? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor improvements
We keep repeating install throughout the document, the app never mentions the word install (mentions Get started, and Start task) . I suggest we provide congruent terminology among docs and product. The user experience does not give the feel of installing something, it's configuring and starting a task. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more feedback
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you make the links to external resources and to the CircleCI web app open in a new tab. For example:
link:https://platform.openai.com/settings/organization/general[OpenAI Platform, window=_blank]
The following table shows the configuration options available when setting up Chunk: | ||
|
||
.Chunk configuration options | ||
[cols="1,2,1"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about making the Description
column narrower, so the Default
one has a little more space?
* Details of the proposed fix | ||
* Details of the level of verification achieved | ||
|
||
#Screenshot# |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The actual screenshot is missing.
. Enter your API key for your chosen model provider. | ||
. Select btn:[Next] to complete the setup. | ||
|
||
#Screenshots# |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The actual screenshot is missing.
|
||
When you select btn:[Start task] Chunk starts running immediately and follows the schedule you set up. | ||
|
||
#insert screenshots# |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The actual screenshot is missing.
Description
Added new guide based off https://discuss.circleci.com/t/product-launch-agentic-capability-fixing-flaky-tests/53975
Reasons
Why did you make these changes?
Content Checklist
Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.
Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):