Skip to content
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

Merged
merged 15 commits into from
Dec 19, 2024

Conversation

stephanbcbauer
Copy link
Member

@stephanbcbauer stephanbcbauer commented Nov 27, 2024

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:

Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

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.

Copy link
Member Author

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

Copy link
Contributor

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.

@stephanbcbauer stephanbcbauer marked this pull request as ready for review December 19, 2024 07:27
@stephanbcbauer
Copy link
Member Author

@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

@stephanbcbauer stephanbcbauer dismissed evegufy’s stale review December 19, 2024 07:38

already forwarded to umbrella

@stephanbcbauer stephanbcbauer merged commit be5fbd1 into eclipse-tractusx:main Dec 19, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants