feat(docs/schema): improve eks, kfdisitribution schema docs #290
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
ralgozino
requested review from
speziato,
alessiodionisi,
smerlos and
g-iannelli
ralgozino
force-pushed
the
feat/improved-schema-docs
branch
from
44ffd2a to
0a130e4
Compare
speziato
requested changes
Nov 11, 2024
|
I've merged your suggestions @speziato and ported them to the other schemas too. |
|
@g-iannelli please take a look at the docs for EKS. Thanks! |
g-iannelli
requested changes
Nov 21, 2024
There was a problem hiding this comment.
@ralgozino IMHO you should rebase the branch after the merge of #303
ralgozino
force-pushed
the
feat/improved-schema-docs
branch
from
ebbd6c8 to
c981bda
Compare
rebased as requested @g-iannelli |
Port the improvements done for on-prem schema in #268 to the EKS and KFDDistribution schemas and banners used to render the markdown. Some minor improvements to On-premises too. fixes sighupio/product-management#543 sighupio/furyctl#287
Co-authored-by: Riccardo Cannella <riccardo.cannella@sighup.io>
ralgozino
force-pushed
the
feat/improved-schema-docs
branch
from
c981bda to
b0eb79c
Compare
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.
Port to the
EKSClusterandKFDDistributionschemas documentation the improvements done for theon-premschema in #268. Some minor improvements to on-premises too.For review purposes you can focus on the files in the folders:
banners/schemas/public/The rest of the files are generated using
make generate-go-modelsandmake generate-docs.Closes https://github.com/sighupio/product-management/issues/543 sighupio/furyctl#287
Note
In order to generate the markdown files you need a patched version of
md-genotherwise the markdown generation fails with a type assertion error.: