-
Notifications
You must be signed in to change notification settings - Fork 635
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: Consolidate getting started guide and remove duplicated examples #658
docs: Consolidate getting started guide and remove duplicated examples #658
Conversation
There are some examples that are duplicated in the getting started guide and in the examples folder itself. This commit removes the duplicated examples and updates the getting started guide to include then from real source files that are passed through the linter and have tests.
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.
I've reviewed the previews and I think it removes quite a bit of duplication from the docs. It also removes an extra build task which is no longer necessary with this change. Overall, I'm sure there will still be fixes needed to improve our docs, but its a step in the right direction.
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.
Changes LGTM, and this looks like a step in the right direction for docs examples.
* feat: plugin user interaction for web * chore: unnecessary check * chore: reviews * chore: adding version * chore: adding version * chore: reviews * chore: reviews * chore: reviews * chore: fixes after merge * chore: reviews * chore: updating version * chore: lint Co-authored-by: Mayur Kale <mayurkale@google.com>
Partially fixes #547
This PR:
To be done in follow up PRs
Preview: https://opentelemetry-python-mauricio.readthedocs.io/en/mauricio-consolidate-getting-started-guide/getting-started.html