Update the magefile DocsBuild target to new location of CLI reference #3129
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
PR getporter#2897 moved the CLI reference file, but the CLI reference generation still points to the old location. Signed-off-by: Kim Christensen <[email protected]>
kichristensen
requested review from
schristoff,
sgettys,
bdegeeter and
troy0820
as code owners
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.
What does this change
PR #2897 moved the CLI reference file, but the CLI reference generation still points to the old location. That also means that the CLI reference haven't be updated since except for manual changes.
Notes for the reviewer
The structure of the CLI reference documentation will change a little, the "folder" structure will disappear. That is a downside, but compared to having the CLI reference up-to-date, I think it is fine.
If we want to have a folder structure, it could be implemented in a different PR, as it requires a greater amount of changes to the CLI reference docs generation
Current
New
Checklist