[Backport release-2.3] docs: Enclose the CLI version number in backticks#56
Merged
Conversation
At the top of our generated docs we have a line like:x ``` This documentation is for the `crossplane` CLI v2.4.0-rc.0.10.gb96ad2d. ``` When using a development build (no version number) or a build with a proper version number (v2.3.1), this is fine. But when using a main branch build like the example above, the version number triggers some vale linter errors. Enclose the version number in backticks (make it inline code) so that vale will ignore it. This will look fine in the rendered docs as well. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io> (cherry picked from commit da5165c)
github-actions
Bot
requested review from
a team,
jcogilvie and
tampakrap
as code owners
3 tasks
adamwg
approved these changes
May 29, 2026
tampakrap
approved these changes
May 29, 2026
phisco
approved these changes
May 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Backport of #55 to
release-2.3.