Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop custom SCSS now provided by Docsy 0.7.2 #3560

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,6 @@ body.td-page--draft .td-content {
}
}

// TODO(@chalin): upstream
.tab-body {
> .highlight:only-child {
margin: -1.5rem;
max-width: calc(100% + 3rem);
}
}

details {
margin-bottom: $paragraph-margin-bottom;
}
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/instrumentation/erlang/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Zipkin also run by [docker-compose](https://docs.docker.com/compose/).
To export to the running Collector the `opentelemetry_exporter` package must be
added to the project's dependencies:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
{deps, [{opentelemetry_api, "~> {{% param versions.otelApi %}}"},
Expand Down Expand Up @@ -56,7 +56,7 @@ attempts to initialize and use the exporter.
Example of Release configuration in `rebar.config` and for
[mix's Release task](https://hexdocs.pm/mix/Mix.Tasks.Release.html):

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% rebar.config
Expand Down Expand Up @@ -94,7 +94,7 @@ the HTTP protocol with endpoint of `localhost` on port `4318`. If using `grpc`
for the `otlp_protocol` the endpoint should be changed to
`http://localhost:4317`.

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% config/sys.config.src
Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/instrumentation/erlang/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ more telemetry backends.
To get started with this guide, create a new project with `rebar3` or `mix`:
{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}
```erlang
rebar3 new release otel_getting_started
Expand All @@ -322,7 +322,7 @@ Then, in the project you just created, add both `opentelemetry_api` and
`opentelemetry` as dependencies. We add both because this is a project we will
run as a Release and export spans from.
{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}
```erlang
{deps, [{opentelemetry_api, "~> {{% param versions.otelApi %}}"},
Expand All @@ -346,7 +346,7 @@ In the case of Erlang, the API Application will also need to be added to
`src/otel_getting_started.app.src` and a `relx` section to `rebar.config`. In an
Elixir project, a `releases` section needs to be added to `mix.exs`:
{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}
```erlang
%% src/otel_getting_started.app.src
Expand Down Expand Up @@ -413,7 +413,7 @@ To configure OpenTelemetry to use a particular exporter, in this case
the `exporter` for the span processor `otel_batch_processor`, a type of span
processor that batches up multiple spans over a period of time:
{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}
```erlang
%% config/sys.config.src
Expand All @@ -440,7 +440,7 @@ config :opentelemetry,
Now that the dependencies and configuration are set up, we can create a module
with a function `hello/0` that starts some spans:
{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}
```erlang
%% apps/otel_getting_started/src/otel_getting_started.erl
Expand Down
20 changes: 10 additions & 10 deletions content/en/docs/instrumentation/erlang/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ interactive shell, a `Tracer` with a blank name and version is used.
The created `Tracer`'s record can be looked up by the name of a module in the
OTP Application:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
opentelemetry:get_application_tracer(?MODULE)
Expand All @@ -75,7 +75,7 @@ This is how the Erlang and Elixir macros for starting and updating `Spans` get a
Now that you have [Tracer](/docs/concepts/signals/traces/#tracer)s initialized,
you can create [Spans](/docs/concepts/signals/traces/#spans).

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
?with_span(main, #{}, fun() ->
Expand Down Expand Up @@ -104,7 +104,7 @@ common kind of Span to create.

### Create Nested Spans

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
parent_function() ->
Expand Down Expand Up @@ -160,7 +160,7 @@ attaching the context and setting the new span as currently active in the
process. The whole context should be attached in order to not lose other
telemetry data like [baggage](/docs/specs/otel/baggage/api/).

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
SpanCtx = ?start_span(child),
Expand Down Expand Up @@ -204,7 +204,7 @@ Span Links that causally link it to another Span. A
[Link](/docs/concepts/signals/traces/#span-links) needs a Span context to be
created.

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
Parent = ?current_span_ctx,
Expand Down Expand Up @@ -243,7 +243,7 @@ The following example shows the two ways of setting attributes on a span by both
setting an attribute in the start options and then again with `set_attributes`
in the body of the span operation:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
?with_span(my_span, #{attributes => [{'start-opts-attr', <<"start-opts-value">>}]},
Expand Down Expand Up @@ -276,7 +276,7 @@ from the specification and provided in
For example, an instrumentation for an HTTP client or server would need to
include semantic attributes like the scheme of the URL:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
-include_lib("opentelemetry_semantic_conventions/include/trace.hrl").
Expand Down Expand Up @@ -306,7 +306,7 @@ message on an [Span](/docs/concepts/signals/traces/#spans) that represents a
discrete event with no duration that can be tracked by a single timestamp. You
can think of it like a primitive log.

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
?add_event(<<"Gonna try it">>),
Expand All @@ -330,7 +330,7 @@ Tracer.add_event("Did it!")

Events can also have attributes of their own:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
?add_event(<<"Process exited with reason">>, [{pid, Pid)}, {reason, Reason}]))
Expand All @@ -354,7 +354,7 @@ could override the Error status with `StatusCode.OK`, but don’t set

The status can be set at any time before the span is finished:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
-include_lib("opentelemetry_api/include/opentelemetry.hrl").
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/instrumentation/erlang/propagation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ propagators. By default the global propagators used are the W3C
These global propagators can be configured by the Application environment
variable `text_map_propagators`:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% sys.config
Expand Down Expand Up @@ -55,7 +55,7 @@ and `b3multi`.
To manually inject or extract context the `otel_propagator_text_map` module can
be used:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% uses the context from the process dictionary to add to an empty list of headers
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/instrumentation/erlang/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ detectors use the OS environment variable `OTEL_RESOURCE_ATTRIBUTES` and the
The detectors to use is a list of module names and can be configured in the
Application configuration:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% sys.config
Expand Down Expand Up @@ -61,7 +61,7 @@ OTEL_RESOURCE_ATTRIBUTES="deployment.environment=development"
Alternatively, use the `resource` Application environment under the
`opentelemetry` Application configuration of `sys.config` or `runtime.exs`:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% sys.config
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/instrumentation/erlang/sampling.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This tells the SDK to sample spans such that only 10% of Traces get created.
Example in the Application configuration with a root sampler for sampling 10% of
Traces and using the parent decision in the other cases:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% config/sys.config.src
Expand Down Expand Up @@ -107,7 +107,7 @@ export OTEL_TRACES_SAMPLER="parentbased_always_off"
Here's an example in the Application configuration with a root sampler that
always samples and using the parent decision in the other cases:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% config/sys.config.src
Expand Down Expand Up @@ -137,7 +137,7 @@ Custom samplers can be created by implementing the
[`otel_sampler` behaviour](https://hexdocs.pm/opentelemetry/1.3.0/otel_sampler.html#callbacks).
This example sampler:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
-module(attribute_sampler).
Expand Down Expand Up @@ -202,7 +202,7 @@ passed as the sampler's configuration.
Example configuration to not sample any Span with an attribute specifying the
URL requested is `/healthcheck`:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
{opentelemetry, {sampler, {attributes_sampler, #{'http.target' => <<"/healthcheck">>}}}}
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/instrumentation/erlang/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ validation.
Only the `opentelemetry` and `opentelemetry_api` libraries are required for
testing in Elixir/Erlang:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
{deps, [{opentelemetry_api, "~> {{% param versions.otelApi %}}"},
Expand All @@ -39,7 +39,7 @@ Set your `exporter` to `:none` and the span processor to
`:otel_simple_processor`. This ensure that your tests don't actually export data
to a destination, and that spans can be analyzed after they are processed.

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% config/sys.config.src
Expand Down Expand Up @@ -69,7 +69,7 @@ A modified version of the `hello` function from the
[Getting Started](/docs/instrumentation/erlang/getting-started/) guide will
serve as our test case:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
%% apps/otel_getting_started/src/otel_getting_started.erl
Expand Down Expand Up @@ -108,7 +108,7 @@ end

## Testing

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Erlang %}}
{{< tabpane text=true >}} {{% tab Erlang %}}

```erlang
-module(otel_getting_started_SUITE).
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/instrumentation/js/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ JavaScript) from the
[Getting Started](/docs/instrumentation/js/getting-started/nodejs/) like the
following to export traces and metrics via OTLP (`http/protobuf`) :

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Typescript %}}
{{< tabpane text=true >}} {{% tab Typescript %}}

```ts
/*instrumentation.ts*/
Expand Down Expand Up @@ -374,7 +374,7 @@ npm install --save @opentelemetry/exporter-prometheus
Update your OpenTelemetry configuration to use the exporter and to send data to
your Prometheus backend:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Typescript %}}
{{< tabpane text=true >}} {{% tab Typescript %}}

```ts
import * as opentelemetry from '@opentelemetry/sdk-node';
Expand Down Expand Up @@ -449,7 +449,7 @@ npm install --save @opentelemetry/exporter-zipkin
Update your OpenTelemetry configuration to use the exporter and to send data to
your Zipkin backend:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Typescript %}}
{{< tabpane text=true >}} {{% tab Typescript %}}

```ts
import * as opentelemetry from '@opentelemetry/sdk-node';
Expand Down Expand Up @@ -495,7 +495,7 @@ allow you to either emit spans one-by-one or batched. If not specified otherwise
the SDK will use the `BatchSpanProcessor`. If you do not want to batch your
spans, you can use the `SimpleSpanProcessor` instead as follows:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab Typescript %}}
{{< tabpane text=true >}} {{% tab Typescript %}}

```ts
/*instrumentation.ts*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ npm install express
Create a file named `app.ts` (or `app.js` if not using TypeScript) and add the
following code to it:

{{% tabpane text=true langEqualsHeader=true %}} {{% tab TypeScript %}}
{{% tabpane text=true %}} {{% tab TypeScript %}}

```ts
/*app.ts*/
Expand Down Expand Up @@ -171,7 +171,7 @@ application code. One tool commonly used for this task is the
Create a file named `instrumentation.ts` (or `instrumentation.js` if not using
TypeScript) , which will contain your instrumentation setup code.

{{< tabpane text=true langEqualsHeader=true >}} {{% tab TypeScript %}}
{{< tabpane text=true >}} {{% tab TypeScript %}}

```ts
/*instrumentation.ts*/
Expand Down Expand Up @@ -484,7 +484,7 @@ If you'd like to explore a more complex example, take a look at the
Did something go wrong? You can enable diagnostic logging to validate that
OpenTelemetry is initialized correctly:

{{< tabpane text=true langEqualsHeader=true >}} {{% tab TypeScript %}}
{{< tabpane text=true >}} {{% tab TypeScript %}}

```ts
/*instrumentation.ts*/
Expand Down
Loading