Ignore Operator references in the spellcheck #46259
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
github-actions
bot
requested review from
mmcallister,
r0mant,
xinding33 and
zmb3
|
Backport note: cherry-pick this branch on to #45538. |
r0mant
approved these changes
Sep 4, 2024
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-9l8104jpi-goteleport.vercel.app/docs/ver/preview |
hugoShaka
approved these changes
Sep 4, 2024
public-teleport-github-review-bot
bot
removed request for
mmcallister,
zmb3 and
xinding33
Teleport Operator reference docs contain a large number of internal link references that fail the spell checker. Until we find a more scalable spell check workflow (#46191), ignore these reference docs in the spell checker.
ptgott
force-pushed
the
paul.gottschling/2024-09-04-spell-ref
branch
from
e4e78fb to
831cebf
Compare
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-pyq5uung4-goteleport.vercel.app/docs/ver/preview |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 5, 2024
* Auto-generate operator CRD docs Backports #44107 * Auto-generate operator CRD docs We already pull JSON schema data from Teleport protobuf message definitions in order to generate CRD manifests. Extract a shared library from code within the existing protoc plugin for generating CRDs. This way, we can use the library to generate docs for our CRDs with a separate plugin, and don't need to complicate the interface for using the existing plugin. - Organize `integrations/crdgen` into `lib` and `cmd` directories, turning `lib` into a package. - Edit the `generateSchema` signature to include a function that formats a CRD into a document, injecting separate functions for formatting the CRD as YAML and as a docs page. - Add Makefile targets for building the docs plugin and generating CRD docs. To display the resulting reference pages in the docs, this change configures `docs/config.json` to generate the Reference section of the sidebar from the docs directory. This requires moving the Helm reference includes directory into `docs/pages/includes`. * Respond to hugoShaka feedback - Do not display the `status` field. - Indicate that enum fields can take an integer or a string. This is consistent with our comment conventions, which describe both the integer and the string values for each enum option. * Sort CRD reference page sections Also handle duplicate page sections by including the names of parent properties within section headings. * Fix crdgen Makefile targets - bring test data and hack out of `lib/` - fix broken debug builds - add crd-docs checks to the `crds-up-to-date` target - trigger proto lint on CRD and CRD doc changes - removed stale gitkeep in `docs/pages/includes/crd-docs/.gitkeep` - split crdgen formatting logic in another file for readability - update license header years on new files * fixup! Fix crdgen Makefile targets * lint files due to false positive 'generated' comment * fixup! lint files due to false positive 'generated' comment * Incorporate rosstimothy feedback Remove an unnecessary package. Also regenerate the CRD docs. * fix debug builds and gitignore * fixup! fix debug builds and gitignore * Respond to rosstimothy feedback Fix integrations/operator/crdgen/Makefile * Fix spelling * Fix flaky propertyTable test Compare the unsorted slice elements, since sorting takes place on the containing VersionSection. --------- Co-authored-by: hugoShaka <hugo.hervieux@goteleport.com> * Ignore Operator references in the spellcheck Backports #46259 Teleport Operator reference docs contain a large number of internal link references that fail the spell checker. Until we find a more scalable spell check workflow (#46191), ignore these reference docs in the spell checker. * Update Operator docs * Fix lint error --------- Co-authored-by: hugoShaka <hugo.hervieux@goteleport.com>
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.
Teleport Operator reference docs contain a large number of internal link references that fail the spell checker. Until we find a more scalable spell check workflow (#46191), ignore these reference docs in the spell checker.