Clarify spec.path in API docs #566
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
+ in the `spec.path` of the Flux `Kustomization` In #2357 it was noted that we mention `spec.path` but the code example provided for context is a `GitRepository`. This is a leap too far, let's provide this to better clarify the context. Signed-off-by: Kingdon Barrett <[email protected]>
stefanprodan
changed the title
stefanprodan
changed the title
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.
Fixes fluxcd/flux2#2357 - Docs accessibility
It's clear what was intended here if you know that Flux Kustomization has
spec.pathand GitRepository doesn't have any such a field, but that's presumptive about the user's knowledge. Let's not assume they've already learned and retained that.