diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 41e756a8adf..839bcdb2939 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 diff --git a/.github/workflows/links-fail-fast.yml b/.github/workflows/links-fail-fast.yml index 12793a196cb..7bc1215119e 100644 --- a/.github/workflows/links-fail-fast.yml +++ b/.github/workflows/links-fail-fast.yml @@ -14,3 +14,4 @@ jobs: uses: lycheeverse/lychee-action@v1.9.3 with: fail: true + args: --max-concurrency 5 . diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 222318339ad..0b77bb86703 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9f2bac55bf..7847b459088 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/Makefile b/Makefile index 6b6a01c1441..da5daf94c09 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/attribute/README.md b/attribute/README.md new file mode 100644 index 00000000000..5b3da8f14ca --- /dev/null +++ b/attribute/README.md @@ -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) diff --git a/baggage/README.md b/baggage/README.md new file mode 100644 index 00000000000..7d798435e12 --- /dev/null +++ b/baggage/README.md @@ -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) diff --git a/bridge/README.md b/bridge/README.md new file mode 100644 index 00000000000..40dbcdec865 --- /dev/null +++ b/bridge/README.md @@ -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) diff --git a/bridge/opencensus/README.md b/bridge/opencensus/README.md new file mode 100644 index 00000000000..f80f8d7a37e --- /dev/null +++ b/bridge/opencensus/README.md @@ -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) diff --git a/bridge/opentracing/migration/README.md b/bridge/opentracing/migration/README.md new file mode 100644 index 00000000000..2324d5e8ec1 --- /dev/null +++ b/bridge/opentracing/migration/README.md @@ -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) diff --git a/codes/README.md b/codes/README.md new file mode 100644 index 00000000000..24c52b387d2 --- /dev/null +++ b/codes/README.md @@ -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) diff --git a/exporters/otlp/README.md b/exporters/otlp/README.md new file mode 100644 index 00000000000..dc1b4fa3c71 --- /dev/null +++ b/exporters/otlp/README.md @@ -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) diff --git a/exporters/otlp/otlpmetric/README.md b/exporters/otlp/otlpmetric/README.md new file mode 100644 index 00000000000..e8665b0cb7d --- /dev/null +++ b/exporters/otlp/otlpmetric/README.md @@ -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) diff --git a/exporters/otlp/otlpmetric/otlpmetricgrpc/README.md b/exporters/otlp/otlpmetric/otlpmetricgrpc/README.md new file mode 100644 index 00000000000..9184068d89c --- /dev/null +++ b/exporters/otlp/otlpmetric/otlpmetricgrpc/README.md @@ -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) diff --git a/exporters/otlp/otlpmetric/otlpmetrichttp/README.md b/exporters/otlp/otlpmetric/otlpmetrichttp/README.md new file mode 100644 index 00000000000..b02cdcbbed4 --- /dev/null +++ b/exporters/otlp/otlpmetric/otlpmetrichttp/README.md @@ -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) diff --git a/exporters/otlp/otlptrace/README.md b/exporters/otlp/otlptrace/README.md new file mode 100644 index 00000000000..50802d5aee6 --- /dev/null +++ b/exporters/otlp/otlptrace/README.md @@ -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) diff --git a/exporters/otlp/otlptrace/otlptracegrpc/README.md b/exporters/otlp/otlptrace/otlptracegrpc/README.md new file mode 100644 index 00000000000..5309bb7cb1c --- /dev/null +++ b/exporters/otlp/otlptrace/otlptracegrpc/README.md @@ -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) diff --git a/exporters/otlp/otlptrace/otlptracehttp/README.md b/exporters/otlp/otlptrace/otlptracehttp/README.md new file mode 100644 index 00000000000..36526400941 --- /dev/null +++ b/exporters/otlp/otlptrace/otlptracehttp/README.md @@ -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) diff --git a/exporters/prometheus/README.md b/exporters/prometheus/README.md new file mode 100644 index 00000000000..f4dc09d3861 --- /dev/null +++ b/exporters/prometheus/README.md @@ -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) diff --git a/exporters/stdout/README.md b/exporters/stdout/README.md new file mode 100644 index 00000000000..433144e9212 --- /dev/null +++ b/exporters/stdout/README.md @@ -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) diff --git a/exporters/stdout/stdoutmetric/README.md b/exporters/stdout/stdoutmetric/README.md new file mode 100644 index 00000000000..5d9191ca657 --- /dev/null +++ b/exporters/stdout/stdoutmetric/README.md @@ -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) diff --git a/exporters/stdout/stdouttrace/README.md b/exporters/stdout/stdouttrace/README.md new file mode 100644 index 00000000000..f84dee7ee46 --- /dev/null +++ b/exporters/stdout/stdouttrace/README.md @@ -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) diff --git a/exporters/zipkin/README.md b/exporters/zipkin/README.md new file mode 100644 index 00000000000..d30506dc3c6 --- /dev/null +++ b/exporters/zipkin/README.md @@ -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) diff --git a/log/README.md b/log/README.md new file mode 100644 index 00000000000..3f714271191 --- /dev/null +++ b/log/README.md @@ -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) diff --git a/log/embedded/README.md b/log/embedded/README.md new file mode 100644 index 00000000000..bae4ac68f0b --- /dev/null +++ b/log/embedded/README.md @@ -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) diff --git a/log/global/README.md b/log/global/README.md new file mode 100644 index 00000000000..11e5afefc01 --- /dev/null +++ b/log/global/README.md @@ -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) diff --git a/log/noop/README.md b/log/noop/README.md new file mode 100644 index 00000000000..da08ea6381d --- /dev/null +++ b/log/noop/README.md @@ -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) diff --git a/metric/README.md b/metric/README.md new file mode 100644 index 00000000000..0cf902e01f0 --- /dev/null +++ b/metric/README.md @@ -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) diff --git a/metric/embedded/README.md b/metric/embedded/README.md new file mode 100644 index 00000000000..1f6e0efa73d --- /dev/null +++ b/metric/embedded/README.md @@ -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) diff --git a/metric/noop/README.md b/metric/noop/README.md new file mode 100644 index 00000000000..bb89694356b --- /dev/null +++ b/metric/noop/README.md @@ -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) diff --git a/propagation/README.md b/propagation/README.md new file mode 100644 index 00000000000..e2959ac747a --- /dev/null +++ b/propagation/README.md @@ -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) diff --git a/schema/v1.0/README.md b/schema/v1.0/README.md new file mode 100644 index 00000000000..58a92bb2940 --- /dev/null +++ b/schema/v1.0/README.md @@ -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) diff --git a/schema/v1.0/ast/README.md b/schema/v1.0/ast/README.md new file mode 100644 index 00000000000..65ce75fdd4b --- /dev/null +++ b/schema/v1.0/ast/README.md @@ -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) diff --git a/schema/v1.0/types/README.md b/schema/v1.0/types/README.md new file mode 100644 index 00000000000..187158281d6 --- /dev/null +++ b/schema/v1.0/types/README.md @@ -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) diff --git a/schema/v1.1/README.md b/schema/v1.1/README.md new file mode 100644 index 00000000000..4ce7fff965e --- /dev/null +++ b/schema/v1.1/README.md @@ -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) diff --git a/schema/v1.1/ast/README.md b/schema/v1.1/ast/README.md new file mode 100644 index 00000000000..cc61dd23557 --- /dev/null +++ b/schema/v1.1/ast/README.md @@ -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) diff --git a/schema/v1.1/types/README.md b/schema/v1.1/types/README.md new file mode 100644 index 00000000000..82e56148f10 --- /dev/null +++ b/schema/v1.1/types/README.md @@ -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) diff --git a/sdk/README.md b/sdk/README.md new file mode 100644 index 00000000000..f81b1576ad4 --- /dev/null +++ b/sdk/README.md @@ -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) diff --git a/sdk/instrumentation/README.md b/sdk/instrumentation/README.md new file mode 100644 index 00000000000..06e6d868548 --- /dev/null +++ b/sdk/instrumentation/README.md @@ -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) diff --git a/sdk/log/README.md b/sdk/log/README.md new file mode 100644 index 00000000000..729aca0913a --- /dev/null +++ b/sdk/log/README.md @@ -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) diff --git a/sdk/metric/README.md b/sdk/metric/README.md new file mode 100644 index 00000000000..017f072a51b --- /dev/null +++ b/sdk/metric/README.md @@ -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) diff --git a/sdk/metric/metricdata/README.md b/sdk/metric/metricdata/README.md new file mode 100644 index 00000000000..d1390df1b5e --- /dev/null +++ b/sdk/metric/metricdata/README.md @@ -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) diff --git a/sdk/metric/metricdata/metricdatatest/README.md b/sdk/metric/metricdata/metricdatatest/README.md new file mode 100644 index 00000000000..969ffde50bd --- /dev/null +++ b/sdk/metric/metricdata/metricdatatest/README.md @@ -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) diff --git a/sdk/resource/README.md b/sdk/resource/README.md new file mode 100644 index 00000000000..4ad864d716e --- /dev/null +++ b/sdk/resource/README.md @@ -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) diff --git a/sdk/trace/README.md b/sdk/trace/README.md new file mode 100644 index 00000000000..f2936e14392 --- /dev/null +++ b/sdk/trace/README.md @@ -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) diff --git a/sdk/trace/tracetest/README.md b/sdk/trace/tracetest/README.md new file mode 100644 index 00000000000..0678d6564f5 --- /dev/null +++ b/sdk/trace/tracetest/README.md @@ -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) diff --git a/semconv/README.md b/semconv/README.md new file mode 100644 index 00000000000..e114ce2cf81 --- /dev/null +++ b/semconv/README.md @@ -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) diff --git a/semconv/v1.10.0/README.md b/semconv/v1.10.0/README.md new file mode 100644 index 00000000000..c692442c37e --- /dev/null +++ b/semconv/v1.10.0/README.md @@ -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) diff --git a/semconv/v1.11.0/README.md b/semconv/v1.11.0/README.md new file mode 100644 index 00000000000..99d80c23230 --- /dev/null +++ b/semconv/v1.11.0/README.md @@ -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) diff --git a/semconv/v1.12.0/README.md b/semconv/v1.12.0/README.md new file mode 100644 index 00000000000..6a273180feb --- /dev/null +++ b/semconv/v1.12.0/README.md @@ -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) diff --git a/semconv/v1.13.0/README.md b/semconv/v1.13.0/README.md new file mode 100644 index 00000000000..ccdb7701774 --- /dev/null +++ b/semconv/v1.13.0/README.md @@ -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) diff --git a/semconv/v1.13.0/httpconv/README.md b/semconv/v1.13.0/httpconv/README.md new file mode 100644 index 00000000000..813f51ef24f --- /dev/null +++ b/semconv/v1.13.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.13.0/netconv/README.md b/semconv/v1.13.0/netconv/README.md new file mode 100644 index 00000000000..62566341fd1 --- /dev/null +++ b/semconv/v1.13.0/netconv/README.md @@ -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) diff --git a/semconv/v1.14.0/README.md b/semconv/v1.14.0/README.md new file mode 100644 index 00000000000..0caf1e29c4c --- /dev/null +++ b/semconv/v1.14.0/README.md @@ -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) diff --git a/semconv/v1.14.0/httpconv/README.md b/semconv/v1.14.0/httpconv/README.md new file mode 100644 index 00000000000..4cc429abbdb --- /dev/null +++ b/semconv/v1.14.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.14.0/netconv/README.md b/semconv/v1.14.0/netconv/README.md new file mode 100644 index 00000000000..6479b27ae27 --- /dev/null +++ b/semconv/v1.14.0/netconv/README.md @@ -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) diff --git a/semconv/v1.15.0/README.md b/semconv/v1.15.0/README.md new file mode 100644 index 00000000000..c68bd14771e --- /dev/null +++ b/semconv/v1.15.0/README.md @@ -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) diff --git a/semconv/v1.15.0/httpconv/README.md b/semconv/v1.15.0/httpconv/README.md new file mode 100644 index 00000000000..744e848e35d --- /dev/null +++ b/semconv/v1.15.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.15.0/netconv/README.md b/semconv/v1.15.0/netconv/README.md new file mode 100644 index 00000000000..09b04116094 --- /dev/null +++ b/semconv/v1.15.0/netconv/README.md @@ -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) diff --git a/semconv/v1.16.0/README.md b/semconv/v1.16.0/README.md new file mode 100644 index 00000000000..b976ad14d12 --- /dev/null +++ b/semconv/v1.16.0/README.md @@ -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) diff --git a/semconv/v1.16.0/httpconv/README.md b/semconv/v1.16.0/httpconv/README.md new file mode 100644 index 00000000000..7b35b818036 --- /dev/null +++ b/semconv/v1.16.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.16.0/netconv/README.md b/semconv/v1.16.0/netconv/README.md new file mode 100644 index 00000000000..8ba73ae8074 --- /dev/null +++ b/semconv/v1.16.0/netconv/README.md @@ -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) diff --git a/semconv/v1.17.0/README.md b/semconv/v1.17.0/README.md new file mode 100644 index 00000000000..87b842c5d11 --- /dev/null +++ b/semconv/v1.17.0/README.md @@ -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) diff --git a/semconv/v1.17.0/httpconv/README.md b/semconv/v1.17.0/httpconv/README.md new file mode 100644 index 00000000000..18ee2f3d623 --- /dev/null +++ b/semconv/v1.17.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.17.0/netconv/README.md b/semconv/v1.17.0/netconv/README.md new file mode 100644 index 00000000000..8ba73ae8074 --- /dev/null +++ b/semconv/v1.17.0/netconv/README.md @@ -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) diff --git a/semconv/v1.18.0/README.md b/semconv/v1.18.0/README.md new file mode 100644 index 00000000000..5f03e01386f --- /dev/null +++ b/semconv/v1.18.0/README.md @@ -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) diff --git a/semconv/v1.18.0/httpconv/README.md b/semconv/v1.18.0/httpconv/README.md new file mode 100644 index 00000000000..d258bef9857 --- /dev/null +++ b/semconv/v1.18.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.18.0/netconv/README.md b/semconv/v1.18.0/netconv/README.md new file mode 100644 index 00000000000..01c2712e274 --- /dev/null +++ b/semconv/v1.18.0/netconv/README.md @@ -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) diff --git a/semconv/v1.19.0/README.md b/semconv/v1.19.0/README.md new file mode 100644 index 00000000000..eb69c6ecc1f --- /dev/null +++ b/semconv/v1.19.0/README.md @@ -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) diff --git a/semconv/v1.19.0/httpconv/README.md b/semconv/v1.19.0/httpconv/README.md new file mode 100644 index 00000000000..dcadf974e19 --- /dev/null +++ b/semconv/v1.19.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.19.0/netconv/README.md b/semconv/v1.19.0/netconv/README.md new file mode 100644 index 00000000000..220212536a0 --- /dev/null +++ b/semconv/v1.19.0/netconv/README.md @@ -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) diff --git a/semconv/v1.20.0/README.md b/semconv/v1.20.0/README.md new file mode 100644 index 00000000000..82e1f46b4ea --- /dev/null +++ b/semconv/v1.20.0/README.md @@ -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) diff --git a/semconv/v1.20.0/httpconv/README.md b/semconv/v1.20.0/httpconv/README.md new file mode 100644 index 00000000000..96b4b0d0b19 --- /dev/null +++ b/semconv/v1.20.0/httpconv/README.md @@ -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) diff --git a/semconv/v1.20.0/netconv/README.md b/semconv/v1.20.0/netconv/README.md new file mode 100644 index 00000000000..adc863a992c --- /dev/null +++ b/semconv/v1.20.0/netconv/README.md @@ -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) diff --git a/semconv/v1.21.0/README.md b/semconv/v1.21.0/README.md new file mode 100644 index 00000000000..bc60aa6039a --- /dev/null +++ b/semconv/v1.21.0/README.md @@ -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) diff --git a/semconv/v1.22.0/README.md b/semconv/v1.22.0/README.md new file mode 100644 index 00000000000..85d4985f3df --- /dev/null +++ b/semconv/v1.22.0/README.md @@ -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) diff --git a/semconv/v1.23.0/README.md b/semconv/v1.23.0/README.md new file mode 100644 index 00000000000..c019f7a7952 --- /dev/null +++ b/semconv/v1.23.0/README.md @@ -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) diff --git a/semconv/v1.23.1/README.md b/semconv/v1.23.1/README.md new file mode 100644 index 00000000000..357375d2e55 --- /dev/null +++ b/semconv/v1.23.1/README.md @@ -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) diff --git a/semconv/v1.24.0/README.md b/semconv/v1.24.0/README.md new file mode 100644 index 00000000000..0b6cbe960cb --- /dev/null +++ b/semconv/v1.24.0/README.md @@ -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) diff --git a/semconv/v1.4.0/README.md b/semconv/v1.4.0/README.md new file mode 100644 index 00000000000..cfbc9055b32 --- /dev/null +++ b/semconv/v1.4.0/README.md @@ -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) diff --git a/semconv/v1.5.0/README.md b/semconv/v1.5.0/README.md new file mode 100644 index 00000000000..db74482b8c7 --- /dev/null +++ b/semconv/v1.5.0/README.md @@ -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) diff --git a/semconv/v1.6.1/README.md b/semconv/v1.6.1/README.md new file mode 100644 index 00000000000..974c9c0fe04 --- /dev/null +++ b/semconv/v1.6.1/README.md @@ -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) diff --git a/semconv/v1.7.0/README.md b/semconv/v1.7.0/README.md new file mode 100644 index 00000000000..bf578303f39 --- /dev/null +++ b/semconv/v1.7.0/README.md @@ -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) diff --git a/semconv/v1.8.0/README.md b/semconv/v1.8.0/README.md new file mode 100644 index 00000000000..a8afd5b0456 --- /dev/null +++ b/semconv/v1.8.0/README.md @@ -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) diff --git a/semconv/v1.9.0/README.md b/semconv/v1.9.0/README.md new file mode 100644 index 00000000000..9c1054ca9ba --- /dev/null +++ b/semconv/v1.9.0/README.md @@ -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) diff --git a/trace/README.md b/trace/README.md new file mode 100644 index 00000000000..58ccaba69b1 --- /dev/null +++ b/trace/README.md @@ -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) diff --git a/trace/embedded/README.md b/trace/embedded/README.md new file mode 100644 index 00000000000..7754a239ee6 --- /dev/null +++ b/trace/embedded/README.md @@ -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) diff --git a/trace/noop/README.md b/trace/noop/README.md new file mode 100644 index 00000000000..cd382c82a1a --- /dev/null +++ b/trace/noop/README.md @@ -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) diff --git a/verify_readmes.sh b/verify_readmes.sh new file mode 100755 index 00000000000..1e87855eeaa --- /dev/null +++ b/verify_readmes.sh @@ -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