Skip to content

fix(tutorials): Update API health check commands and add JSON parsing with jq #570

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

Conversation

awellnitz-materna
Copy link
Contributor

@awellnitz-materna awellnitz-materna commented Dec 19, 2023

Description

We were able to gather many impressions at the first TractusX Community Days. This also resulted in some suggestions for improvement.

With this PR we want to integrate the following suggestions.

  • Executable commands should be in separate lines so that they can be easily copied on the website
  • jq should be appended to the end of the whole reuqest as in MXD, this improves readability

Closes #564
Closes #562
Closes #548
Closes #560

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

stephanbcbauer
stephanbcbauer previously approved these changes Jan 21, 2024
Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

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

LGTM

@stephanbcbauer stephanbcbauer changed the title fix: Update API health check commands and add JSON parsing with jq fix(tutorials): Update API health check commands and add JSON parsing with jq Jan 21, 2024
@stephanbcbauer stephanbcbauer added the documentation Improvements or additions to documentation label Jan 21, 2024
@stephanbcbauer
Copy link
Member

@florianrusch-zf we would need a second reviewer ;) for the tutorials

Co-authored-by: Florian Rusch (ZF Friedrichshafen AG) <[email protected]>
Co-authored-by: Florian Rusch (ZF Friedrichshafen AG) <[email protected]>
Copy link
Contributor

@florianrusch-zf florianrusch-zf left a comment

Choose a reason for hiding this comment

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

Sorry, I just wanted to remove the spaces and not the code fences 😅 the suggestion syntax is a little bit confusing regarding changing code fences

Co-authored-by: Florian Rusch (ZF Friedrichshafen AG) <[email protected]>
Co-authored-by: Florian Rusch (ZF Friedrichshafen AG) <[email protected]>
awellnitz-materna and others added 2 commits January 23, 2024 08:09
Co-authored-by: Florian Rusch (ZF Friedrichshafen AG) <[email protected]>
Co-authored-by: Florian Rusch (ZF Friedrichshafen AG) <[email protected]>
Copy link
Contributor Author

@awellnitz-materna awellnitz-materna left a comment

Choose a reason for hiding this comment

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

Now it looks good again 😄

Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

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

LGTM

@stephanbcbauer stephanbcbauer merged commit 670a4b1 into eclipse-tractusx:main Jan 23, 2024
@awellnitz-materna awellnitz-materna deleted the feature/improve-tutorials branch January 23, 2024 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants