From 9d7779a7d76bb97580e83307084df7304ef62bfe Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 14 Oct 2022 19:18:53 -0400 Subject: [PATCH] [docs] Add API and Examples to Go sidenav (#3280) Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com> --- website_docs/_index.md | 18 +++--------------- website_docs/api.md | 10 ++++++++++ website_docs/examples.md | 9 +++++++++ 3 files changed, 22 insertions(+), 15 deletions(-) create mode 100644 website_docs/api.md create mode 100644 website_docs/examples.md diff --git a/website_docs/_index.md b/website_docs/_index.md index 536a52dd339..dcd70c74d37 100644 --- a/website_docs/_index.md +++ b/website_docs/_index.md @@ -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) diff --git a/website_docs/api.md b/website_docs/api.md new file mode 100644 index 00000000000..a5c5867f8d0 --- /dev/null +++ b/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 +--- diff --git a/website_docs/examples.md b/website_docs/examples.md new file mode 100644 index 00000000000..51a92b7d799 --- /dev/null +++ b/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 +---