go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-10-31 00:07:40 +02:00
Code Issues Releases Activity

Add READMEs to every package (#5103)

Browse Source
This commit is contained in:
Damien Mathieu
2024-03-26 20:13:54 +01:00
committed by GitHub
parent f1ba32e95e
commit edb788bf49
89 changed files with 290 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@@ -37,7 +37,7 @@ jobs:
- name: Generate
run: make generate
- name: Run linters
run: make dependabot-check license-check lint vanity-import-check
run: make dependabot-check license-check lint vanity-import-check verify-readmes
- name: Build
run: make build
- name: Check clean repository

1
.github/workflows/links-fail-fast.yml vendored
View File

@@ -14,3 +14,4 @@ jobs:
uses: lycheeverse/lychee-action@v1.9.3
with:
fail: true
args: --max-concurrency 5 .

2
.github/workflows/links.yml vendored
View File

@@ -17,6 +17,8 @@ jobs:
- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v1.9.3
with:
args: --max-concurrency 5 .
- name: Create Issue From File
if: steps.lychee.outputs.exit_code != 0

10
CONTRIBUTING.md
View File

@@ -201,6 +201,16 @@ You can install and run a "local Go Doc site" in the following way:
[`go.opentelemetry.io/otel/metric`](https://pkg.go.dev/go.opentelemetry.io/otel/metric)
is an example of a very well-documented package.
### README files
Each (non-internal, non-test, non-documentation) package must contain a
`README.md` file containing at least a title, and a `pkg.go.dev` badge.
The README should not be a repetition of Go doc comments.
You can verify the presence of all README files with the `make verify-readmes`
command.
## Style Guide
One of the primary goals of this project is that it is actually used by

8
Makefile
View File

@@ -14,8 +14,8 @@ TIMEOUT = 60
.DEFAULT_GOAL := precommit
.PHONY: precommit ci
precommit: generate dependabot-generate license-check misspell go-mod-tidy golangci-lint-fix test-default
ci: generate dependabot-check license-check lint vanity-import-check build test-default check-clean-work-tree test-coverage
precommit: generate dependabot-generate license-check misspell go-mod-tidy golangci-lint-fix verify-readmes test-default
ci: generate dependabot-check license-check lint vanity-import-check verify-readmes build test-default check-clean-work-tree test-coverage
# Tools
@@ -305,3 +305,7 @@ add-tags: | $(MULTIMOD)
.PHONY: lint-markdown
lint-markdown:
docker run -v "$(CURDIR):$(WORKDIR)" avtodev/markdown-lint:v1 -c $(WORKDIR)/.markdownlint.yaml $(WORKDIR)/**/*.md
.PHONY: verify-readmes
verify-readmes:
./verify_readmes.sh

3
attribute/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Attribute
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/attribute)](https://pkg.go.dev/go.opentelemetry.io/otel/attribute)

3
baggage/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Baggage
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/baggage)](https://pkg.go.dev/go.opentelemetry.io/otel/baggage)

3
bridge/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Bridge
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/bridge)](https://pkg.go.dev/go.opentelemetry.io/otel/bridge)

3
bridge/opencensus/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OpenTelemetry/OpenCensus Bridge
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/bridge/opencensus)](https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opencensus)

3
bridge/opentracing/migration/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OpenTracing Migration
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/bridge/opentracing/migration)](https://pkg.go.dev/go.opentelemetry.io/otel/bridge/opentracing/migration)

3
codes/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Codes
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/codes)](https://pkg.go.dev/go.opentelemetry.io/otel/codes)

3
exporters/otlp/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Exporters
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp)

3
exporters/otlp/otlpmetric/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Metric Exporters
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlpmetric)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlpmetric)

3
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Metric gRPC Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc)

3
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Metric HTTP Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp)

3
exporters/otlp/otlptrace/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Trace Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlptrace)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace)

3
exporters/otlp/otlptrace/otlptracegrpc/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Trace gRPC Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc)

3
exporters/otlp/otlptrace/otlptracehttp/README.md Normal file
View File

@@ -0,0 +1,3 @@
# OTLP Trace HTTP Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)

3
exporters/prometheus/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Prometheus Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/prometheus)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/prometheus)

3
exporters/stdout/README.md Normal file
View File

@@ -0,0 +1,3 @@
# STDOUT Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/stdout)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/stdout)

3
exporters/stdout/stdoutmetric/README.md Normal file
View File

@@ -0,0 +1,3 @@
# STDOUT Metric Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/stdout/stdoutmetric)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/stdout/stdoutmetric)

3
exporters/stdout/stdouttrace/README.md Normal file
View File

@@ -0,0 +1,3 @@
# STDOUT Trace Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/stdout/stdouttrace)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/stdout/stdouttrace)

3
exporters/zipkin/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Zipkin Exporter
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/zipkin)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/zipkin)

3
log/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Log API
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/log)](https://pkg.go.dev/go.opentelemetry.io/otel/log)

3
log/embedded/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Log Embedded
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/log/embedded)](https://pkg.go.dev/go.opentelemetry.io/otel/log/embedded)

3
log/global/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Log Global
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/log/global)](https://pkg.go.dev/go.opentelemetry.io/otel/log/global)

3
log/noop/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Log Noop
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/log/noop)](https://pkg.go.dev/go.opentelemetry.io/otel/log/noop)

3
metric/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Metric API
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/metric)](https://pkg.go.dev/go.opentelemetry.io/otel/metric)

3
metric/embedded/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Metric Embedded
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/metric/embedded)](https://pkg.go.dev/go.opentelemetry.io/otel/metric/embedded)

3
metric/noop/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Metric Noop
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/metric/noop)](https://pkg.go.dev/go.opentelemetry.io/otel/metric/noop)

3
propagation/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Propagation
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/propagation)](https://pkg.go.dev/go.opentelemetry.io/otel/propagation)

3
schema/v1.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Schema v1.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/schema/v1.0)](https://pkg.go.dev/go.opentelemetry.io/otel/schema/v1.0)

3
schema/v1.0/ast/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Schema v1.0 AST
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/schema/v1.0/ast)](https://pkg.go.dev/go.opentelemetry.io/otel/schema/v1.0/ast)

3
schema/v1.0/types/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Schema v1.0 Types
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/schema/v1.0/types)](https://pkg.go.dev/go.opentelemetry.io/otel/schema/v1.0/types)

3
schema/v1.1/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Schema v1.1
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/schema/v1.1)](https://pkg.go.dev/go.opentelemetry.io/otel/schema/v1.1)

3
schema/v1.1/ast/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Schema v1.1 AST
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/schema/v1.1/ast)](https://pkg.go.dev/go.opentelemetry.io/otel/schema/v1.1/ast)

3
schema/v1.1/types/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Schema v1.1 Types
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/schema/v1.1/types)](https://pkg.go.dev/go.opentelemetry.io/otel/schema/v1.1/types)

3
sdk/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk)

3
sdk/instrumentation/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK Instrumentation
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/instrumentation)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/instrumentation)

3
sdk/log/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Log SDK
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/log)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/log)

3
sdk/metric/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Metric SDK
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/metric)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric)

3
sdk/metric/metricdata/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK Metric data
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/metric/metricdata)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric/metricdata)

3
sdk/metric/metricdata/metricdatatest/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK Metric data test
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/metric/metricdata/metricdatatest)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric/metricdata/metricdatatest)

3
sdk/resource/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK Resource
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/resource)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/resource)

3
sdk/trace/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK Trace
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/trace)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/trace)

3
sdk/trace/tracetest/README.md Normal file
View File

@@ -0,0 +1,3 @@
# SDK Trace test
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/sdk/trace/tracetest)](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/trace/tracetest)

3
semconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv)

3
semconv/v1.10.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.10.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.10.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.10.0)

3
semconv/v1.11.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.11.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.11.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.11.0)

3
semconv/v1.12.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.12.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.12.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.12.0)

3
semconv/v1.13.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.13.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.13.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.13.0)

3
semconv/v1.13.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.13.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.13.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.13.0/httpconv)

3
semconv/v1.13.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.13.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.13.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.13.0/netconv)

3
semconv/v1.14.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.14.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.14.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.14.0)

3
semconv/v1.14.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.14.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.14.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.14.0/httpconv)

3
semconv/v1.14.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.14.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.14.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.14.0/netconv)

3
semconv/v1.15.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.15.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.15.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.15.0)

3
semconv/v1.15.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.15.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.15.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.15.0/httpconv)

3
semconv/v1.15.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.15.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.15.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.15.0/netconv)

3
semconv/v1.16.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.16.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.16.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.16.0)

3
semconv/v1.16.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.16.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.16.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.16.0/httpconv)

3
semconv/v1.16.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.16.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.16.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.16.0/netconv)

3
semconv/v1.17.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.17.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.17.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.17.0)

3
semconv/v1.17.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.17.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.17.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.17.0/httpconv)

3
semconv/v1.17.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.16.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.16.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.16.0/netconv)

3
semconv/v1.18.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.18.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.18.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.18.0)

3
semconv/v1.18.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.18.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.18.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.18.0/httpconv)

3
semconv/v1.18.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.18.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.18.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.18.0/netconv)

3
semconv/v1.19.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.19.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.19.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.19.0)

3
semconv/v1.19.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.19.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.19.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.19.0/httpconv)

3
semconv/v1.19.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.19.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.19.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.19.0/netconv)

3
semconv/v1.20.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.20.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.20.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.20.0)

3
semconv/v1.20.0/httpconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.20.0 HTTP conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.20.0/httpconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.20.0/httpconv)

3
semconv/v1.20.0/netconv/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.20.0 NET conv
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.20.0/netconv)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.20.0/netconv)

3
semconv/v1.21.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.21.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.21.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.21.0)

3
semconv/v1.22.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.22.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.22.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.22.0)

3
semconv/v1.23.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.23.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.23.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.23.0)

3
semconv/v1.23.1/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.23.1
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.23.1)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.23.1)

3
semconv/v1.24.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.24.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.24.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.24.0)

3
semconv/v1.4.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.4.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.4.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.4.0)

3
semconv/v1.5.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.5.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.5.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.5.0)

3
semconv/v1.6.1/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.6.1
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.6.1)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.6.1)

3
semconv/v1.7.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.7.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.7.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.7.0)

3
semconv/v1.8.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.8.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.8.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.8.0)

3
semconv/v1.9.0/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Semconv v1.9.0
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/semconv/v1.9.0)](https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.9.0)

3
trace/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Trace API
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/trace)](https://pkg.go.dev/go.opentelemetry.io/otel/trace)

3
trace/embedded/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Trace Embedded
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/trace/embedded)](https://pkg.go.dev/go.opentelemetry.io/otel/trace/embedded)

3
trace/noop/README.md Normal file
View File

@@ -0,0 +1,3 @@
# Trace Noop
[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel/trace/noop)](https://pkg.go.dev/go.opentelemetry.io/otel/trace/noop)

21
verify_readmes.sh Executable file
View File

@@ -0,0 +1,21 @@
#!/bin/bash
# Copyright The OpenTelemetry Authors
# SPDX-License-Identifier: Apache-2.0
set -euo pipefail
dirs=$(find . -type d -not -path "*/internal*" -not -path "*/test*" -not -path "*/example*" -not -path "*/.*" | sort)
missingReadme=false
for dir in $dirs; do
if [ ! -f "$dir/README.md" ]; then
echo "couldn't find README.md for $dir"
missingReadme=true
fi
done
if [ "$missingReadme" = true ] ; then
echo "Error: some READMEs couldn't be found."
exit 1
fi