From a7e34c3fadca7f1759cba72b5b31b59bb858dccb Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Mon, 15 Jan 2024 15:07:34 +0100 Subject: [PATCH] Remove outdated templates (#3775) --- templates/language-docs/_index.md | 29 ------------------ templates/language-docs/exporting-data.md | 31 -------------------- templates/language-docs/getting-started.md | 34 ---------------------- templates/language-docs/instrumentation.md | 33 --------------------- 4 files changed, 127 deletions(-) delete mode 100644 templates/language-docs/_index.md delete mode 100644 templates/language-docs/exporting-data.md delete mode 100644 templates/language-docs/getting-started.md delete mode 100644 templates/language-docs/instrumentation.md diff --git a/templates/language-docs/_index.md b/templates/language-docs/_index.md deleted file mode 100644 index 7e21f6b84bc0..000000000000 --- a/templates/language-docs/_index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Language name -weight: 1 ---- - -This is the index page for a given language. It has an introduction to -OpenTelemetry in that language, a section to indicate the maturity of the -API/SDK, and links to the repository. If links to other external canonical -documentation exist, they should also go here (i.e., API references) - -A link to the upstream repository should be prominent in the introduction. - -## Status and Releases - -Important status or maturity information should go into a table here, as below. - -| Tracing | Metrics | -| ------- | ------- | -| Beta | Alpha | - -{{% docs/latest-release "language-name" /%}} - -## Further Reading - -This can be a list of links to other references/examples, if appropriate. - -- API Reference Documentation -- Example code in repository -- Videos or other resources diff --git a/templates/language-docs/exporting-data.md b/templates/language-docs/exporting-data.md deleted file mode 100644 index 1edd8990e336..000000000000 --- a/templates/language-docs/exporting-data.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Processing and Exporting Data -weight: 4 ---- - -This page should cover the built-in processors and exporters for the SDK, along -with other SDK configuration information. - -If the SDK supports env var configuration, those should be listed in this -section. - -## Sampling - -How to configure head sampling, and the different samplers available. - -## Resources - -Adding resources (such as service name/version) or using resource detectors. - -## Processors - -Filtering, batching, etc. - -## OTLP Exporter - -For this and the other exporters, a basic guide to the configuration options for -these exporters and links to more complete documentation where appropriate. - -## Jaeger Exporter - -## Prometheus Exporter diff --git a/templates/language-docs/getting-started.md b/templates/language-docs/getting-started.md deleted file mode 100644 index e8e4e8285f43..000000000000 --- a/templates/language-docs/getting-started.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Getting Started -weight: 2 ---- - -This page will walk a new end-user through the process of installing the API, -SDK, and a console exporter along with a brief code snippet/"hello world!". - -## Installation - -How to add the API, SDK, and an exporter to a project, and how to import it. - -If the language offers automatic instrumentation, then the instructions on how -to install that should also go in this section. - -## Initialization and Configuration - -This section should demonstrate provider and basic exporter configurations, -along with a brief explanation of required defaults or best practices. - -### Creating a Tracer Provider - -### Creating a Metric Provider - -As the metrics API remains unstable, metrics documentation can be deferred - -### Creating a Console Exporter - -## Quick Start - -This should be a basic example of installing and configuring the API and SDK. - -If automatic instrumentation is available through code imports (such as library -wrapper or monkeypatching), this should also be included. diff --git a/templates/language-docs/instrumentation.md b/templates/language-docs/instrumentation.md deleted file mode 100644 index c7c557ed9b79..000000000000 --- a/templates/language-docs/instrumentation.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Instrumentation -weight: 3 ---- - -This page should be a human readable guide to instrumentation in the language. - -The main topics to cover will be creating and annotating spans, creating and -annotating metrics, how to pass context, and (if available) a guide to automatic -instrumentation in the language. - -## Creating Spans - -### Attributes - -#### Semantic Attributes - -### Events - -## Creating Metrics - -As the metrics API remains unstable, metrics documentation can be deferred - -## Propagators and Context - -## Automatic Instrumentation - -If this is available, then this section should cover: - -- Configuring automatic instrumentation for the language -- Examples of creating new child spans from AI parents -- List of libraries supported for automatic instrumentation -- How to create new automatic instrumentation, possibly?