Skip to content

Config overrides, URL orbs and centralised config #9411

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

Merged
merged 9 commits into from
Jun 3, 2025

Conversation

rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented May 30, 2025

Description

  • Adds override-with key to config reference
  • Add references to URL orbs to orb intro and orb author pages
  • Adds a guide to overriding config

To do:

  • cross references
  • add FAQ with link to discuss for users to feedback
  • check for and update TODOs

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.

yaningo and others added 4 commits May 30, 2025 10:18
* Adding new  key paragraph to config reference

* Implementing review suggestions
* add sections to introduce url orbs

* Update jekyll/_cci2/orb-intro.adoc

* Adding `override-with` key to config reference (#9370)

* Adding new  key paragraph to config reference

* Implementing review suggestions

---------

Co-authored-by: Yann D. <yaningo@users.noreply.github.com>
* scaffolding for simple example done.

* some formatting updates

* structural changes and corrections

* fixes

* Adding `override-with` key to config reference (#9370)

* Adding new  key paragraph to config reference

* Implementing review suggestions

* updates from review

* update syntax and add note to update URL

* fix link and typo

---------

Co-authored-by: Yann D. <yaningo@users.noreply.github.com>
* combine orb author guides and mention URL orbs

* fix links
* Creating URL orb related how-to page

* Completing and improving page content

* Implementing review suggestions

* Addressing review comments

* Adding note for screenshots

* add screenshots

---------

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
@rosieyohannan rosieyohannan changed the title [WIP] Config overrides, URL orbs and centralised config Config overrides, URL orbs and centralised config Jun 3, 2025
@rosieyohannan rosieyohannan marked this pull request as ready for review June 3, 2025 22:00
@rosieyohannan rosieyohannan requested review from a team as code owners June 3, 2025 22:00
@rosieyohannan rosieyohannan merged commit 9198c0b into master Jun 3, 2025
2 of 3 checks passed
@rosieyohannan rosieyohannan deleted the DOCSS-1771-overrides-url-orbs branch June 4, 2025 10:46
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.

3 participants