Add complete devfiles to advanced guides #6388
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
openshift-ci
bot
added
the
kind/feature
✅ Deploy Preview for odo-docusaurus-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
openshift-ci
bot
added
the
area/documentation
|
Kudos, SonarCloud Quality Gate passed!
|
rm3l
reviewed
Dec 8, 2022
There was a problem hiding this comment.
LGTM. I agree there is a lot of repetitive data, but since the Devfiles are quite different, it might be hard to factorize, IMO. Not an expert with MDX / JSX stuff, but there might be some room for reusability. So I am not sure it would be worth spending time right now trying to optimize this.
However, this makes me think of 2 things:
- Based on a recent discussion, maybe we could use each of those Devfiles as input in E2E tests, and import them as is in these docs. This way, we would be able to test them as well. And for line highlighting in the Docs, I can imagine some generic MDX Component accepting the path to the Devfile along with line numbers as input properties, so as to keep highlighting the relevant lines.
- These Advanced Guides could be simplified further now that we support parsing multi-document YAML in a single K8s component (Add support for parsing multiple k8s definition in a single Devfile K8s component #6372)
But that's another story that can be handled in separate PRs.
27 tasks
rm3l
approved these changes
Dec 8, 2022
openshift-ci
bot
added
the
lgtm
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 type of PR is this:
/kind feature
/area documentation
What does this PR do / why we need it:
This PR adds complete Devfile to all the advanced guides.
Which issue(s) this PR fixes:
Fixes #6337
PR acceptance criteria:
Unit test
Integration test
Documentation
How to test changes / Special notes to the reviewer:
Nodejs, Go, Java, Dotnet