Skip to content

Commit e6c2f44

Browse files
authored
Update README.md (open-telemetry#1428)
1 parent b8ff552 commit e6c2f44

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,22 @@
3838

3939
## OpenTelemetry Python
4040

41-
The Python [OpenTelemetry](https://opentelemetry.io/) implementation.
41+
This page describes the Python [OpenTelemetry](https://opentelemetry.io/) implementation. OpenTelemetry is an observability framework for cloud-native software.
4242

4343
## Getting started
4444

45-
OpenTelemetry's goal is to provide a single set of APIs to capture distributed traces and metrics from your application and send them to an observability platform. This project allows you to do just that for applications written in Python.
45+
The goal of OpenTelemetry is to provide a single set of APIs to capture distributed traces and metrics from your application and send them to an observability platform. This project lets you do just that for applications written in Python.
4646

4747
This repository includes multiple installable packages. The `opentelemetry-api`
48-
package includes abstract classes and no-op implementations that comprise the OpenTelemetry API following
49-
[the
50-
specification](https://github.com/open-telemetry/opentelemetry-specification).
48+
package includes abstract classes and no-op implementations that comprise the OpenTelemetry API following the
49+
[OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification).
5150
The `opentelemetry-sdk` package is the reference implementation of the API.
5251

5352
Libraries that produce telemetry data should only depend on `opentelemetry-api`,
5453
and defer the choice of the SDK to the application developer. Applications may
5554
depend on `opentelemetry-sdk` or another package that implements the API.
5655

57-
The API and SDK packages are available on PyPI, and can installed via `pip`:
56+
The API and SDK packages are available on the Python Package Index (PyPI). You can install them via `pip` with the following commands:
5857

5958
```sh
6059
pip install opentelemetry-api
@@ -63,22 +62,22 @@ pip install opentelemetry-sdk
6362

6463
The
6564
[`instrumentation/`](https://github.com/open-telemetry/opentelemetry-python/tree/master/instrumentation)
66-
directory includes OpenTelemetry instrumentation packages, which can be installed separately as:
65+
directory includes OpenTelemetry instrumentation packages. You can install the packages separately with the following command:
6766

6867
```sh
6968
pip install opentelemetry-instrumentation-{instrumentation}
7069
```
7170

7271
The
7372
[`exporter/`](https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter)
74-
directory includes OpenTelemetry exporter packages, which can be installed separately as:
73+
directory includes OpenTelemetry exporter packages. You can install the packages separately with the following command:
7574

7675
```sh
7776
pip install opentelemetry-exporter-{exporter}
7877
```
7978

8079
To install the development versions of these packages instead, clone or fork
81-
this repo and do an [editable
80+
this repository and perform an [editable
8281
install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs):
8382

8483
```sh
@@ -87,17 +86,20 @@ pip install -e ./opentelemetry-sdk
8786
pip install -e ./instrumentation/opentelemetry-instrumentation-{instrumentation}
8887
```
8988

89+
For additional exporter and instrumentation packages, see the
90+
[`opentelemetry-python-contrib`](https://github.com/open-telemetry/opentelemetry-python-contrib) repository.
91+
9092
## Documentation
9193

92-
The online documentation is available at https://opentelemetry-python.readthedocs.io/,
93-
if you want to access the documentation for the latest version use
94+
The online documentation is available at https://opentelemetry-python.readthedocs.io/.
95+
To access the latest version of the documentation, see
9496
https://opentelemetry-python.readthedocs.io/en/latest/.
9597

9698
## Contributing
9799

98-
See [CONTRIBUTING.md](CONTRIBUTING.md).
100+
For information about contributing to OpenTelemetry Python, see [CONTRIBUTING.md](CONTRIBUTING.md).
99101

100-
We meet weekly on Thursday at 9AM PT. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) for specific dates.
102+
We meet weekly on Thursdays at 9AM PST. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) for specific dates.
101103

102104
Meetings take place via [Zoom video conference](https://zoom.us/j/6729396170).
103105

@@ -115,14 +117,14 @@ Approvers ([@open-telemetry/python-approvers](https://github.com/orgs/open-telem
115117
- [Reiley Yang](https://github.com/reyang), Microsoft
116118
- [Yusuke Tsutsumi](https://github.com/toumorokoshi), Google
117119

118-
*Find more about the approver role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver).*
120+
*For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver).*
119121

120122
Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-telemetry/teams/python-maintainers)):
121123

122124
- [Alex Boten](https://github.com/codeboten), Lightstep
123125
- [Leighton Chen](https://github.com/lzchen), Microsoft
124126

125-
*Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).*
127+
*For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).*
126128

127129
### Thanks to all the people who already contributed!
128130

@@ -132,5 +134,9 @@ Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-t
132134

133135
## Project Status
134136

135-
Project [boards](https://github.com/open-telemetry/opentelemetry-python/projects) and [milestones](https://github.com/open-telemetry/opentelemetry-python/milestones) can be found at the respective links. We try to keep these accurate and should be the best place to go for answers on project status. The dates and features described in issues
136-
and milestones are estimates, and subject to change.
137+
For project boards and milestones, see the following links:
138+
- [Project boards](https://github.com/open-telemetry/opentelemetry-python/projects)
139+
- [Milestones](https://github.com/open-telemetry/opentelemetry-python/milestones)
140+
141+
We try to keep these links accurate, so they're the best place to go for questions about project status. The dates and features described in the issues
142+
and milestones are estimates and subject to change.

0 commit comments

Comments
 (0)