docs: Validate the remote.* component topics - #7097
Open
clayton-cornell wants to merge 17 commits into
Open
clayton-cornell wants to merge 17 commits into
clayton-cornell wants to merge 17 commits into
Conversation
clayton-cornell
added
the
type/docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
|
💻 Deploy preview available (docs: Validate the remote.* component topics): |
clayton-cornell
marked this pull request as draft
September 12, 2026 02:07
clayton-cornell
marked this pull request as ready for review
September 14, 2026 16:53
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
1 participant
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.
This PR is a general cleanup of the
remote.*topics.This is preliminary work that needs to be done as part of an overall project to migrate Examples either to task topics or to scenarios. The foundation of the component doc needs to be in good shape before any other work is undertaken.
Validated against the component source code, looking at Blocks, Arguments, completeness, accuracy, etc. Most fixes are cosmetic (markdown formatting, removing extra spaces, aligning tables). Some fixes covered errors in the existing examples, errors in the debug section, and product name errors.
Added
review_datemetadata to all files that have been reviewed. This is something we should start using on all doc topics going forward once they are fully reviewed, and updated with subsequent reviews.Note for reviewers.
remote.kubernetes.secretto readusername = convert.nonsensitive(remote.kubernetes.secret.credentials.data["username"]). Claude flagged the original line as redundant and suggested multiple variations. I picked this one as the most logical looking, but it needs to be validated.resource_urlandservice_account_file. This what they look like they should be in the source, but I can't tell if they were left out of the docs on purpose or not... or if I'm reading the source incorrectly.