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.
Added several
"markdownDescription"
sections to the JSON Schema forbentofile.yaml
.The "Documentation" link at the end links to an anchored section of the BentoML documentation
Many of the field descriptions were long. It was getting extremely painful to write markdown as a JSON string like this
Many of the markdown descriptions were long and it was extremely difficult
So I ultimately wrote a script to that accepts
bentofileSchema.in.json
using a Jinja-like templating syntaxWhich "flattens" the referenced markdown file to an escaped JSON string and injects it into
bentofileSchema.out.json
by overwriting the file. Kind of an ugly solution... but the DevEx is better as far as writing Markdown descriptions is concerned.