Skip to content

Conversation

@rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Dec 5, 2025

Description

  • Make deploy name required for all update commands in the configure deploy markers doc
  • Remove a linter rule thats not working as expected

Reasons

Avoid confusion

Content checks

Please follow our style when contributing to CircleCI docs. View our style guide or check out our CONTRIBUTING.md for more information.

Preview your changes:

  • View the Vale linter results, select the ci/circleci: lint job at the bottom of your PR. You will be redirected to the vale/lint job output in CircleCI.
  • Preview your changes, select the ci/circleci: build job at the bottom of your PR and you will be redirected to CircleCI. Select the Artifacts tab and select index.html to open a preview version of the docs site built for your latest commit.

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):

Content structure:

  • 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.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Include relevant backlinks to other CircleCI docs/pages.

Formatting:

  • Keep the title between 20 and 70 characters.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).

@rosieyohannan rosieyohannan requested review from a team as code owners December 5, 2025 14:40
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