Skip to content

Commit

Permalink
Readme fixes part2 (#1583)
Browse files Browse the repository at this point in the history
  • Loading branch information
cijothomas authored Feb 27, 2024
1 parent 186c0b0 commit fe85521
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 15 deletions.
3 changes: 3 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"appenders",
"Bhasin",
"Cijo",
"clippy",
"codecov",
"deque",
"Dirkjan",
Expand All @@ -40,6 +41,7 @@
"Kühle",
"Kumar",
"Lalit",
"LIBCLANG",
"msrv",
"Ochtman",
"opentelemetry",
Expand All @@ -48,6 +50,7 @@
"quantile",
"Redelmeier",
"reqwest",
"runtimes",
"rustc",
"Tescher",
"tracerprovider",
Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Open a pull request against the main
repo.

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

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

### Experimental/Unstable features:
### Experimental/Unstable features

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:

Expand All @@ -156,9 +156,10 @@ Use `otel_unstable` feature flag for implementation of specification with [exper
// Your feature implementation
}
```

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.

### Optional features:
### Optional features

The potential features include:

Expand Down
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,22 +94,26 @@ See the [examples](./examples) directory for different integration patterns.
The following crates are maintained in this repo:

* [`opentelemetry`] This is the OpenTelemetry API crate, and is the crate
required to instrument libraries and applications. It contains Logging Bridge
API, Metrics API, and Tracing API.
required to instrument libraries and applications. It contains Context API,
Baggage API, Propagators API, Logging Bridge API, Metrics API, and Tracing
API.
* [`opentelemetry-sdk`] This is the OpenTelemetry SDK crate, and contains the
official OpenTelemetry SDK implementation. It contains Logging SDK, Metrics
SDK, and Tracing SDK.
SDK, and Tracing SDK. It also contains propagator implementations.
* [`opentelemetry-otlp`] exporter for sending logs, metrics and traces in the
OTLP format to an endpoint accepting OTLP, typically the OpenTelemetry
collector.
OTLP format to an endpoint accepting OTLP, like the [OpenTelemetry
collector](https://opentelemetry.io/docs/collector/), or [vendor specific
endpoints](https://opentelemetry.io/ecosystem/vendors/).
* [`opentelemetry-stdout`] exporter for sending logs, metrics and traces to
stdout, for learning/debugging purposes.
* [`opentelemetry-http`] This crate contains utility functions to help with
exporting telemetry, propagation, over [`http`].
* [`opentelemetry-appender-log`] This crate provides logging appender to route
logs emitted using the `log` crate to opentelemetry.
* [`opentelemetry-appender-tracing`] This crate provides logging appender to route
logs emitted using the `tracing` crate to opentelemetry.
logs emitted using the [log](https://docs.rs/log/latest/log/) crate to
opentelemetry.
* [`opentelemetry-appender-tracing`] This crate provides logging appender to
route logs emitted using the [tracing](https://crates.io/crates/tracing) crate
to opentelemetry.
* [`opentelemetry-jaeger-propagator`] provides context propagation using [jaeger
propagation
format](https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format).
Expand Down Expand Up @@ -159,9 +163,9 @@ this policy.
See the [contributing file](CONTRIBUTING.md).

The Rust special interest group (SIG) meets weekly on Tuesdays at 9 AM Pacific
Time. 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)
Time. The meeting is subject to change depending on contributors' availability.
Check the [OpenTelemetry community
calendar](https://github.com/open-telemetry/community?tab=readme-ov-file#calendar)
for specific dates and for Zoom meeting links. "OTel Rust SIG" is the name of
meeting for this group.

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

### Thanks to all the people who have contributed

[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-rust)](https://github.com/open-telemetry/opentelemetry-rust/graphs/contributors)
[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-rust)](https://github.com/open-telemetry/opentelemetry-rust/graphs/contributors)
File renamed without changes.

0 comments on commit fe85521

Please sign in to comment.