Remove dots from operator reference filenames #50734
Merged
Conversation
This file contains 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
ptgott
added
no-changelog
github-actions
bot
requested review from
bernardjkim,
hugoShaka,
marcoandredinis,
mmcallister,
r0mant,
tigrato,
xinding33 and
zmb3
|
Reviewer note: this PR adds redirects to |
|
Amplify deployment status
|
hugoShaka
approved these changes
Jan 3, 2025
The dots cause issues with our hosting infrastructure, which returns 404s when users make requests for Kubernetes operator reference pages with no trailing slash. This change returns a filename from the format function in the CRD/CRD docs generator so we can return different file names for CRDs and their docs. It also renames CRD docs pages to include hyphens instead of dots and underscores, and adds redirects.
ptgott
force-pushed
the
paul.gottschling/2025-01-03-dot-404s
branch
from
8e68065 to
f781ca9
Compare
|
The prose linter failure is due to a bug in which the GHA workflow passes the name of a deleted file to the linter, which exits with an error. The linter isn't required yet, and I'll plan to fix the error next week. |
marcoandredinis
approved these changes
Jan 6, 2025
public-teleport-github-review-bot
bot
removed request for
r0mant,
tigrato,
mmcallister,
zmb3,
bernardjkim and
xinding33
tigrato
approved these changes
Jan 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The dots cause issues with our hosting infrastructure, which returns 404s when users make requests for Kubernetes operator reference pages with no trailing slash.
This change returns a filename from the format function in the CRD/CRD docs generator so we can return different file names for CRDs and their docs. It also renames CRD docs pages to include hyphens instead of dots and underscores, and adds redirects.