Skip to content

Commit f3cff5a

Browse files
gugahoaGustavo Aguiar
authored andcommitted
add doc generation script
1 parent 9084ed2 commit f3cff5a

File tree

4 files changed

+33
-2
lines changed

4 files changed

+33
-2
lines changed

processors/opentelemetry_baggage_processor/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpentelemetryBaggageProcessor
1+
# opentelemetry_baggage_processor
22

33
A Span Processor that takes attributes from the Baggage and insert into the Span.
44

@@ -29,7 +29,7 @@ be found at [https://hexdocs.pm/opentelemetry_baggage_processor](https://hexdocs
2929

3030
<!-- MDOC -->
3131

32-
`OpentelemetryBaggageProcessor` provides a [Span Processor](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#span-processor)
32+
`opentelemetry_baggage_processor` provides a [Span Processor](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#span-processor)
3333
that takes attributes from the [Baggage](https://hexdocs.pm/opentelemetry_api/otel_baggage.html)
3434
and insert into the Span, once it starts.
3535

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{source_url, <<"https://github.com/open-telemetry/opentelemetry-erlang-contrib">>}.
2+
{extras, [<<"README.md">>]}.
3+
{main, <<"readme">>}.
4+
{proglang, erlang}.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/bin/bash
2+
set -e
3+
4+
# Setup:
5+
#
6+
# # 1. install OTP 24+
7+
# # 2. install ExDoc:
8+
# $ mix escript.install github elixir-lang/ex_doc
9+
10+
rebar3 compile
11+
rebar3 edoc
12+
13+
ex_doc "opentelemetry_baggage_processor" 0.0.1 "_build/default/lib/opentelemetry_baggage_processor/ebin" \
14+
--source-ref v0.0.1 \
15+
--config docs.config $@ \
16+
--output "doc"
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{"1.2.0",
2+
[{<<"opentelemetry">>,{pkg,<<"opentelemetry">>,<<"1.0.4">>},0},
3+
{<<"opentelemetry_api">>,{pkg,<<"opentelemetry_api">>,<<"1.0.3">>},0}]}.
4+
[
5+
{pkg_hash,[
6+
{<<"opentelemetry">>, <<"A7DAF00A248715EE72C12BA1CBAD878837E8DCA6E9BEA12A2381A1F27DF9EBB2">>},
7+
{<<"opentelemetry_api">>, <<"77F9644C42340CD8B18C728CDE4822ED55AE136F0D07761B78E8C54DA46AF93A">>}]},
8+
{pkg_hash_ext,[
9+
{<<"opentelemetry">>, <<"D75C3931884817679CA63C21395715427457691F5C9BE06D75B71D74ADC9D0B4">>},
10+
{<<"opentelemetry_api">>, <<"4293E06BD369BC004E6FAD5EDBB56456D891F14BD3F9F1772B18F1923E0678EA">>}]}
11+
].

0 commit comments

Comments
 (0)