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

Update docs #1312

Merged
merged 5 commits into from
Nov 2, 2020
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
```sh
pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
pip install -e ./ext/opentelemetry-instrumentation-{instrumentation}
pip install -e ./instrumentation/opentelemetry-instrumentation-{instrumentation}
```

## Documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
to run these examples. To run this script in the context of the example app,
install ``opentelemetry-example-app``::

pip install -e ext/opentelemetry-instrumentation-grpc/
pip install -e instrumentation/opentelemetry-instrumentation-grpc/
pip install -e docs/examples/opentelemetry-example-app

Then run the server in one shell::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
to run these examples. To run this script in the context of the example app,
install ``opentelemetry-example-app``::

pip install -e ext/opentelemetry-instrumentation-grpc/
pip install -e instrumentation/opentelemetry-instrumentation-grpc/
pip install -e docs/examples/opentelemetry-example-app

Then run the server in one shell::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
to run these examples. To run this script in the context of the example app,
install ``opentelemetry-example-app``::

pip install -e ext/opentelemetry-instrumentation-grpc/
pip install -e instrumentation/opentelemetry-instrumentation-grpc/
pip install -e docs/examples/opentelemetry-example-app

Then run the server in one shell::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
to run these examples. To run this script in the context of the example app,
install ``opentelemetry-example-app``::

pip install -e ext/opentelemetry-instrumentation-grpc/
pip install -e instrumentation/opentelemetry-instrumentation-grpc/
pip install -e docs/examples/opentelemetry-example-app

Then run the server in one shell::
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ The above is a great example, but it's very manual. Within the telemetry space,
* Database calls

To help instrument common scenarios, opentelemetry also has the concept of "instrumentations": packages that are designed to interface
with a specific framework or library, such as Flask and psycopg2. A list of the currently curated extension packages can be found :scm_web:`here <ext/>`.
with a specific framework or library, such as Flask and psycopg2. A list of the currently curated extension packages can be found :scm_web:`here <instrumentation/>`.

We will now instrument a basic Flask application that uses the requests library to send HTTP requests. First, install the instrumentation packages themselves:

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ In addition, there are several extension packages which can be installed separat
pip install opentelemetry-instrumentation-{instrumentation}

These are for exporter and instrumentation packages respectively.
The packages can be found in :scm_web:`instrumentation/ directory of the repository <exporter/>`.
The packages can be found in :scm_web:`instrumentation <instrumentation/>` and :scm_web:`exporter <exporter/>` directory of the repository.

Extensions
----------
Expand Down
2 changes: 1 addition & 1 deletion exporter/opentelemetry-exporter-zipkin/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ long_description = file: README.rst
long_description_content_type = text/x-rst
author = OpenTelemetry Authors
author_email = cncf-opentelemetry-contributors@lists.cncf.io
url = https://github.com/open-telemetry/opentelemetry-python/tree/master/ext/opentelemetry-exporter-zipkin
url = https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter/opentelemetry-exporter-zipkin
platforms = any
license = Apache-2.0
classifiers =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ accomplish this as shown in the example above.

References
----------
* `OpenTelemetry Celery Instrumentation <https://opentelemetry-python.readthedocs.io/en/latest/ext/celery/celery.html>`_
* `OpenTelemetry Celery Instrumentation <https://opentelemetry-python.readthedocs.io/en/latest/instrumentation/celery/celery.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_

Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ Installation
References
----------

* `OpenTelemetry Redis Instrumentation <https://opentelemetry-python.readthedocs.io/en/latest/ext/opentelemetry-instrumentation-redis/opentelemetry-instrumentation-redis.html>`_
* `OpenTelemetry Redis Instrumentation <https://opentelemetry-python.readthedocs.io/en/latest/instrumentation/opentelemetry-instrumentation-redis/opentelemetry-instrumentation-redis.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_