Skip to content
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

Dynamic config docs refresh #8723

Open
wants to merge 30 commits into
base: master
Choose a base branch
from

Conversation

rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Apr 26, 2024

Description

Improvements to main dynamic config overview page https://internal.circleci.com/docs/dynamic-config/:

  • added info to explain main concepts
  • structure improvements
  • increase the scope of use cases

Improvements to the dynamic config how-to guide https://internal.circleci.com/docs/using-dynamic-configuration/:

  • Fixed incorrect description of path filtering example - I think the snippet got updated in line with an orb update at some point but the description didn't
  • Added more accompanying explainers for the snippets
  • Add two new examples: Config splitting, and config splitting plus packing and validating a shared config file

To be added in a separate PR: Diagrams to show various setups, make a sample project in circleci-public to show examples building

Reasons

A link to a GitHub and/or JIRA issue (if applicable).
Otherwise, a brief sentence about why you made 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) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

jekyll/_cci2/dynamic-config.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
@rosieyohannan rosieyohannan marked this pull request as ready for review May 21, 2024 14:43
@rosieyohannan rosieyohannan requested review from a team as code owners May 21, 2024 14:43
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/using-dynamic-configuration.adoc Outdated Show resolved Hide resolved
DeliciousKokas and others added 6 commits May 29, 2024 23:23
…#8778)

* Add config entry for unsafe retries on container runner

* Fix name of error field in monitoring section

* Apply suggestions from code review

Co-authored-by: Rosie Yohannan <rosie@circleci.com>

---------

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
Copy link
Contributor

@imlogang imlogang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed the 4 linting errors in #8784

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants