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

Links in README and example moved to docu #720

Merged

Conversation

PhRosenberger
Copy link
Contributor

@PhRosenberger PhRosenberger commented Mar 14, 2023

Reference to a related issue in the repository

This PR should solve #719.

Add a description

As discussed in the last CCB meeting, we should change the README to only link to the usage examples in the official documentation.

Required steps:

  • Move current example as an example to trace-file section in the docu
  • Add links in the README to trace file section and OSMP examples

Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:

If you can’t check all of them, please explain why.
If all boxes are checked or commented and you have achieved at least one positive review, you can assign the label ReadyForCCBReview!

@PhRosenberger PhRosenberger added the Documentation Everything which impacts the quality of the documentation and guidelines. label Mar 14, 2023
@PhRosenberger PhRosenberger added this to the V3.6.0 milestone Mar 14, 2023
@PhRosenberger PhRosenberger self-assigned this Mar 14, 2023
@PhRosenberger PhRosenberger linked an issue Mar 14, 2023 that may be closed by this pull request
@PhRosenberger
Copy link
Contributor Author

@philipwindecker I do not know, if Syntax highlighting will work for the python-script example.

@PhRosenberger
Copy link
Contributor Author

@philipwindecker I changed the links to the official docu and the classes list to antora, as there was a todo. Please check that, as well.

@philipwindecker
Copy link
Contributor

@philipwindecker I do not know, if Syntax highlighting will work for the python-script example.

Not as is. The source is set to ruby instead of python, therefore applying different styling rules.
I will commit a change to that. With that, it will render correctly.

Copy link
Contributor

@philipwindecker philipwindecker left a comment

Choose a reason for hiding this comment

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

I will update the things I mentioned in doc/architecture/trace_file_example.adoc myself.

doc/architecture/trace_file_example.adoc Outdated Show resolved Hide resolved
doc/_config.adoc Outdated Show resolved Hide resolved
doc/_config.adoc Outdated Show resolved Hide resolved
doc/_config.adoc Outdated Show resolved Hide resolved
@PhRosenberger
Copy link
Contributor Author

@philipwindecker I changed the links to the official docu and the classes list to antora, as there was a todo. Please check that, as well.

@philipwindecker is this ok for you, as well?

README.md Outdated Show resolved Hide resolved
@philipwindecker philipwindecker force-pushed the 719-other-structure-for-usage-examples-needed-in-readme-and-docu branch from d714678 to 1c6244e Compare March 14, 2023 15:27
@PhRosenberger PhRosenberger added the ReadyForCCBReview Indicates that this MR is ready for a final review and merge by the CCB. label Mar 14, 2023
@pmai
Copy link
Contributor

pmai commented Mar 27, 2023

CCB on 2023-03-27: Merge as-is.

@pmai pmai added ReadyToMerge This PR has been approved to merge and will be merged by a member of the CCB. and removed ReadyForCCBReview Indicates that this MR is ready for a final review and merge by the CCB. labels Mar 27, 2023
PhRosenberger and others added 2 commits May 8, 2023 10:18
Signed-off-by: Philipp Rosenberger <philipp.rosenberger@partner.bmw.de>
Signed-off-by: Philip Windecker <philip.windecker@avenyr.de>
@pmai pmai force-pushed the 719-other-structure-for-usage-examples-needed-in-readme-and-docu branch from 1c6244e to 21d231f Compare May 8, 2023 08:19
@pmai pmai merged commit 52710bc into master May 8, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Everything which impacts the quality of the documentation and guidelines. ReadyToMerge This PR has been approved to merge and will be merged by a member of the CCB.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Other structure for usage examples needed in README and docu
3 participants