-
Notifications
You must be signed in to change notification settings - Fork 89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(e2e tutorial): adapt tutorial for tractus-x community days #1097
Conversation
formatting and add structure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why not just link directly link to the README.md from the umbrella? To avoid double maintenance, it appears to be the same content.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not exactly ;) yes some parts are redundant, you are right. But for the tutorial (focus local deployment, with cloned repository e.g) we just copied the parts we need. if someone wants more options, the readme is linked anyway at the beginning of the deployComponents file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree that the readme in the umbrella contains more information but, as far as I see, this document just contains less information, no different information (where I'd also question why - for instance - here wouldn't be needed more information about the OS specifics in regards to network setup).
I'd really prefer that you'd update the README.md in the umbrella or in general the documentation in umbrella so that it fits to what is needed for the tutorial instead of beginning such a double maintenance.
forward to umbrella repository
@evegufy I already deleted most of the content ⇾ not all, but it shouldn't confuse the people any more. Let's clean up the tutorial next year. @matbmoser can you please have a look at this PR? Thanks |
already forwarded to umbrella
Description
This PR deletes redundant information and forwards to the correct description ⇾ umbrella helm chart repository.
The tutorial itself still needs a rework, but since in most chapters we forward to umbrella it shouldn't confuse people any more.
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: