Module Markdown Optional Fields #334
Draft
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
Nalum
commented
Feb 2, 2024
Nalum
force-pushed
the
module-md-optional-fields
branch
2 times, most recently
from
238c3e6
to
c01dd54
Compare
Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
…ults from the module config Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
Nalum
force-pushed
the
module-md-optional-fields
branch
from
b4ba461
to
d6d05d7
Compare
We want to show the labels field (among others) in the markdown table if so that it is part of the documentation rather than showing all the preset labels as individual fields in the docs. Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
|
@stefanprodan with some feedback from the cue team I've gotten this so it now will print the definition of the field, see the README for the blueprints starter module. I want to refine the module so that name and namespace are not output, but wanted to bring it to your attention. |
|
I'm still not getting what I want from the labels and annotations though :/ |
Signed-off-by: Luke Mallon (Nalum) <luke@mallon.ie>
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.
Based on feedback in cue-lang/cue#2783 this PR updates the Markdown document generation to pull the optional fields into the table data. This is done via the
cue.Value.Fields()iterator.