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: Consolidate getting started guide and remove duplicated examples #658

Merged
merged 5 commits into from
May 21, 2020
Merged

docs: Consolidate getting started guide and remove duplicated examples #658

merged 5 commits into from
May 21, 2020

Conversation

mauriciovasquezbernal
Copy link
Member

@mauriciovasquezbernal mauriciovasquezbernal commented May 7, 2020

Partially fixes #547

This PR:

  • Removes duplicated examples
  • Use literal include to have the examples in .py files

To be done in follow up PRs

  • Implement tests for other examples in the getting started guide (if feasible)
  • Understand what to do with opentelemetry-example-app

Preview: https://opentelemetry-python-mauricio.readthedocs.io/en/mauricio-consolidate-getting-started-guide/getting-started.html

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.
@mauriciovasquezbernal mauriciovasquezbernal added the doc Documentation-related label May 7, 2020
@mauriciovasquezbernal mauriciovasquezbernal requested a review from a team May 7, 2020 22:39
@ocelotl ocelotl self-assigned this May 11, 2020
@codeboten codeboten added the needs reviewers PRs with this label are ready for review and needs people to review to move forward. label May 14, 2020
Copy link
Contributor

@codeboten codeboten left a 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.

Copy link
Member

@c24t c24t left a 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.

@codeboten codeboten merged commit 2249748 into open-telemetry:master May 21, 2020
srikanthccv pushed a commit to srikanthccv/opentelemetry-python that referenced this pull request Nov 1, 2020
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related needs reviewers PRs with this label are ready for review and needs people to review to move forward.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Getting started guide and examples overlap
4 participants