Skip to content

Commit fe85521

Browse files
authored
Readme fixes part2 (open-telemetry#1583)
1 parent 186c0b0 commit fe85521

File tree

4 files changed

+23
-15
lines changed

4 files changed

+23
-15
lines changed

.cspell.json

+3
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"appenders",
3131
"Bhasin",
3232
"Cijo",
33+
"clippy",
3334
"codecov",
3435
"deque",
3536
"Dirkjan",
@@ -40,6 +41,7 @@
4041
"Kühle",
4142
"Kumar",
4243
"Lalit",
44+
"LIBCLANG",
4345
"msrv",
4446
"Ochtman",
4547
"opentelemetry",
@@ -48,6 +50,7 @@
4850
"quantile",
4951
"Redelmeier",
5052
"reqwest",
53+
"runtimes",
5154
"rustc",
5255
"Tescher",
5356
"tracerprovider",

CONTRIBUTING.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Open a pull request against the main
7474
repo.
7575

7676
> **Note**
77-
> It is recommended to run [pre-commit script](precommit.sh) from the root of
77+
> It is recommended to run [pre-commit script](scripts/precommit.sh) from the root of
7878
the repo to catch any issues locally.
7979

8080
### How to Receive Comments
@@ -146,7 +146,7 @@ OpenTelemetry supports multiple ways to configure the API, SDK and other compone
146146
- Environment variables
147147
- Compiling time configurations provided in the source code
148148

149-
### Experimental/Unstable features:
149+
### Experimental/Unstable features
150150

151151
Use `otel_unstable` feature flag for implementation of specification with [experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.27.0/specification/document-status.md) status. This approach ensures clear demarcation and safe integration of new or evolving features. Utilize the following structure:
152152

@@ -156,9 +156,10 @@ Use `otel_unstable` feature flag for implementation of specification with [exper
156156
// Your feature implementation
157157
}
158158
```
159+
159160
It's important to regularly review and remove the `otel_unstable` flag from the code once the feature becomes stable. This cleanup process is crucial to maintain the overall code quality and to ensure that stable features are accurately reflected in the main build.
160161

161-
### Optional features:
162+
### Optional features
162163

163164
The potential features include:
164165

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -94,22 +94,26 @@ See the [examples](./examples) directory for different integration patterns.
9494
The following crates are maintained in this repo:
9595

9696
* [`opentelemetry`] This is the OpenTelemetry API crate, and is the crate
97-
required to instrument libraries and applications. It contains Logging Bridge
98-
API, Metrics API, and Tracing API.
97+
required to instrument libraries and applications. It contains Context API,
98+
Baggage API, Propagators API, Logging Bridge API, Metrics API, and Tracing
99+
API.
99100
* [`opentelemetry-sdk`] This is the OpenTelemetry SDK crate, and contains the
100101
official OpenTelemetry SDK implementation. It contains Logging SDK, Metrics
101-
SDK, and Tracing SDK.
102+
SDK, and Tracing SDK. It also contains propagator implementations.
102103
* [`opentelemetry-otlp`] exporter for sending logs, metrics and traces in the
103-
OTLP format to an endpoint accepting OTLP, typically the OpenTelemetry
104-
collector.
104+
OTLP format to an endpoint accepting OTLP, like the [OpenTelemetry
105+
collector](https://opentelemetry.io/docs/collector/), or [vendor specific
106+
endpoints](https://opentelemetry.io/ecosystem/vendors/).
105107
* [`opentelemetry-stdout`] exporter for sending logs, metrics and traces to
106108
stdout, for learning/debugging purposes.
107109
* [`opentelemetry-http`] This crate contains utility functions to help with
108110
exporting telemetry, propagation, over [`http`].
109111
* [`opentelemetry-appender-log`] This crate provides logging appender to route
110-
logs emitted using the `log` crate to opentelemetry.
111-
* [`opentelemetry-appender-tracing`] This crate provides logging appender to route
112-
logs emitted using the `tracing` crate to opentelemetry.
112+
logs emitted using the [log](https://docs.rs/log/latest/log/) crate to
113+
opentelemetry.
114+
* [`opentelemetry-appender-tracing`] This crate provides logging appender to
115+
route logs emitted using the [tracing](https://crates.io/crates/tracing) crate
116+
to opentelemetry.
113117
* [`opentelemetry-jaeger-propagator`] provides context propagation using [jaeger
114118
propagation
115119
format](https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format).
@@ -159,9 +163,9 @@ this policy.
159163
See the [contributing file](CONTRIBUTING.md).
160164

161165
The Rust special interest group (SIG) meets weekly on Tuesdays at 9 AM Pacific
162-
Time. The meeting is subject to change depending on contributors'
163-
availability. Check the [OpenTelemetry community
164-
calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com)
166+
Time. The meeting is subject to change depending on contributors' availability.
167+
Check the [OpenTelemetry community
168+
calendar](https://github.com/open-telemetry/community?tab=readme-ov-file#calendar)
165169
for specific dates and for Zoom meeting links. "OTel Rust SIG" is the name of
166170
meeting for this group.
167171

@@ -200,4 +204,4 @@ For GitHub groups see the [code owners](CODEOWNERS) file.
200204

201205
### Thanks to all the people who have contributed
202206

203-
[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-rust)](https://github.com/open-telemetry/opentelemetry-rust/graphs/contributors)
207+
[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-rust)](https://github.com/open-telemetry/opentelemetry-rust/graphs/contributors)

precommit.sh scripts/precommit.sh

File renamed without changes.

0 commit comments

Comments
 (0)