1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-01-24 03:47:19 +02:00

[docs] Add API and Examples to Go sidenav (#3280)

Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com>
This commit is contained in:
Patrice Chalin 2022-10-14 19:18:53 -04:00 committed by GitHub
parent b6a22abab7
commit 9d7779a7d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 15 deletions

View File

@ -13,20 +13,8 @@ spelling: cSpell:ignore godoc
weight: 16
---
This is the OpenTelemetry for Go documentation. OpenTelemetry is an observability framework -- an API, SDK, and tools that are designed to aid in the generation and collection of application telemetry data such as metrics, logs, and traces. This documentation is designed to help you understand how to get started using OpenTelemetry for Go.
{{% lang_instrumentation_index_head "go" /%}}
## Status and Releases
## More
The current status of the major functional components for OpenTelemetry Go is as follows:
| Traces | Metrics | Logs |
| ------- | ------- | ------- |
| Stable | Alpha | Not Yet Implemented |
{{% latest_release "go" /%}}
## Further Reading
- [godoc](https://pkg.go.dev/go.opentelemetry.io/otel)
- [Examples](https://github.com/open-telemetry/opentelemetry-go/tree/main/example)
- [Contrib Repository](https://github.com/open-telemetry/opentelemetry-go-contrib)
- [Contrib repository](https://github.com/open-telemetry/opentelemetry-go-contrib)

10
website_docs/api.md Normal file
View File

@ -0,0 +1,10 @@
---
title: API reference
linkTitle: API
# Note: this is a placeholder page. Attempting to visit this page will
# redirect to the following URL:
manualLink: https://pkg.go.dev/go.opentelemetry.io/otel
manualLinkTarget: _blank
_build: { render: link }
weight: 50
---

9
website_docs/examples.md Normal file
View File

@ -0,0 +1,9 @@
---
title: Examples
# Note: this is a placeholder page. Attempting to visit this page will
# redirect to the following URL:
manualLink: https://github.com/open-telemetry/opentelemetry-go/tree/main/example
manualLinkTarget: _blank
_build: { render: link }
weight: 60
---