Skip to content

docs: replace version badges with comments in repo-level atlantis.yaml example#5714

Merged
jamengual merged 1 commit intomainfrom
docs/remove-version-badges-from-repo-config
Aug 15, 2025
Merged

docs: replace version badges with comments in repo-level atlantis.yaml example#5714
jamengual merged 1 commit intomainfrom
docs/remove-version-badges-from-repo-config

Conversation

@jamengual
Copy link
Contributor

Summary

Replace HTML badge elements with clean YAML comments in the 'Example Using All Keys' section of the repo-level atlantis.yaml documentation to improve readability while preserving version information.

Changes Made

  • Converted HTML badges to comments: Replaced <Badge text="vX.X.X+" type="info"/> with # Available since vX.X.X
  • Improved readability: The YAML example is now much cleaner and easier to read
  • Maintained version info: All version information is preserved as inline comments
  • Better copyability: Users can now easily copy the YAML without HTML elements

Before vs After

Before:

version: 3 <Badge text="v0.1.0+" type="info"/>
automerge: true <Badge text="v0.15.0+" type="info"/>

After:

version: 3 # Available since v0.1.0
automerge: true # Available since v0.15.0

Motivation

The HTML badge elements made the YAML example cluttered and less readable. Converting to comments:

  • Maintains all version information
  • Improves code readability
  • Makes the example easier to copy/paste
  • Keeps version badges only in server configuration docs as intended

Impact

  • Documentation: Cleaner, more readable YAML examples
  • User Experience: Easier to copy and understand configuration options
  • Consistency: Version badges now only appear in server configuration docs
  • No Breaking Changes: Pure documentation improvement

Files Changed

  • runatlantis.io/docs/repo-level-atlantis-yaml.md: Updated "Example Using All Keys" section

…l example

Replace HTML badge elements with clean YAML comments in the 'Example Using All Keys'
section to improve readability while preserving version information.

Changes:
- Converted <Badge text="vX.X.X+" type="info"/> to # Available since vX.X.X
- Maintains all version information as inline comments
- Improves YAML example readability and copyability
- Version badges remain only in server configuration docs as intended
@github-actions github-actions bot added docs Documentation size/s labels Aug 15, 2025
@jamengual jamengual merged commit 8907e83 into main Aug 15, 2025
35 checks passed
@jamengual jamengual deleted the docs/remove-version-badges-from-repo-config branch August 15, 2025 21:26
ramonvermeulen pushed a commit to bschaatsbergen/atlantis that referenced this pull request Oct 13, 2025
…l example (runatlantis#5714)

Signed-off-by: Ramon Vermeulen <ramonvermeulen98@gmail.com>
dimisjim pushed a commit to dimisjim/atlantis that referenced this pull request Oct 29, 2025
…l example (runatlantis#5714)

Signed-off-by: dimisjim <dimitris.moraitidis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant