Skip to content

Commit

Permalink
[docs] Add API and Examples to Go sidenav (#3280)
Browse files Browse the repository at this point in the history
Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com>
  • Loading branch information
chalin and MadVikingGod committed Oct 14, 2022
1 parent b6a22ab commit 9d7779a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 15 deletions.
18 changes: 3 additions & 15 deletions website_docs/_index.md
Expand Up @@ -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 changes: 10 additions & 0 deletions website_docs/api.md
@@ -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 changes: 9 additions & 0 deletions website_docs/examples.md
@@ -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
---

0 comments on commit 9d7779a

Please sign in to comment.