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

JS docs: path rename getting_started to getting-started #841

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
2 changes: 1 addition & 1 deletion content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Learn more
- [Collector]({{< relref "/docs/collector/getting-started" >}})
- [Go]({{< relref "/docs/go/getting-started" >}})
- [.NET]({{< relref "/docs/net/getting-started" >}})
- [JavaScript]({{< relref "/docs/js/getting_started" >}})
- [JavaScript]({{< relref "/docs/js/getting-started" >}})
- [<i class="fas fa-ellipsis-h"></i>]({{< relref "docs" >}})
</div>
{{< /blocks/cover >}}
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/js/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: JavaScript
description: >-
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/JS_SDK.svg" alt="JS logo"></img>
A language-specific implementation of OpenTelemetry in JavaScript (for Node.JS & the browser).
aliases: [/js/, /js/metrics/, /js/tracing/]
aliases: [/js, /js/metrics, /js/tracing]
weight: 20
---

Expand All @@ -24,6 +24,6 @@ You can find release information [here](https://github.com/open-telemetry/opente
## Further Reading

- [OpenTelemetry for JavaScript on GitHub](https://github.com/open-telemetry/opentelemetry-js)
- [Getting Started](getting_started)
- [Getting Started]({{< relref "getting-started" >}})
- [API Reference](https://open-telemetry.github.io/opentelemetry-js-api)
- [SDK Reference](https://open-telemetry.github.io/opentelemetry-js)
2 changes: 1 addition & 1 deletion content/en/docs/js/api/context.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Context"
title: Context
description: OpenTelemetry JavaScript Context API Documentation
weight: 2
---
Expand Down
6 changes: 4 additions & 2 deletions content/en/docs/js/api/tracing.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Tracing"
title: Tracing
description: OpenTelemetry JavaScript Tracing API Documentation
weight: 2
---

The following is an in-depth explanation of using the API to trace an application with OpenTelemetry JavaScript.
This guide will assume an OpenTelemetry SDK is registered and will walk through only tracing concepts.
To learn how to set up the OpenTelemetry JavaScript SDK, see [Getting Started](../../getting_started) or the [API Reference](https://open-telemetry.github.io/opentelemetry-js-api).
To learn how to set up the OpenTelemetry JavaScript SDK, see [Getting Started][] or the [API Reference](https://open-telemetry.github.io/opentelemetry-js-api).

_Trace API Specification: <https://github.com/open-telemetry/opentelemetry-specification/blob/v1.6.0/specification/trace/api.md>_

Expand Down Expand Up @@ -214,3 +214,5 @@ Consumer spans represent the processing of a job created by a producer and may s
One problem with span names and attributes is recognizing, categorizing, and analyzing them in your tracing backend. Between different applications, libraries, and tracing backends there might be different names and expected values for various attributes. For example, your application may use `http.status` to describe the HTTP status code, but a library you use may use `http.status_code`. In order to solve this problem, OpenTelemetry uses a library of semantic conventions which describe the name and attributes which should be used for specific types of spans. The use of semantic conventions is always recommended where applicable, but they are merely conventions. For example, you may find that some name other than the name suggested by the semantic conventions more accurately describes your span, you may decide not to include a span attribute which is suggested by semantic conventions for privacy reasons, or you may wish to add a custom attribute which isn't covered by semantic conventions. All of these cases are fine, but please keep in mind that if you stray from the semantic conventions, the categorization of spans in your tracing backend may be affected.

_See the current trace semantic conventions in the OpenTelemetry Specification repository: <https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions>_

[Getting Started]: {{< relref "../getting-started" >}}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Getting Started"
title: Getting Started
aliases: [/docs/js/getting_started]
chalin marked this conversation as resolved.
Show resolved Hide resolved
weight: 1
---
These two guides for Node.JS and the browser use simple examples in javascript to get you started with OpenTelemetry. Both will show you the following steps:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Browser"
weight: 2
title: Browser
aliases: [/docs/js/getting_started/browser]
chalin marked this conversation as resolved.
Show resolved Hide resolved
---

This guide uses the example application in HTML & javascript provided below, but the steps to instrument your own application should be broadly the same.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Node.JS"
weight: 2
title: Node.JS
aliases: [/docs/js/getting_started/nodejs]
chalin marked this conversation as resolved.
Show resolved Hide resolved
---

This guide will show you how to get started with tracing in Node.js.
Expand Down
8 changes: 6 additions & 2 deletions content/en/docs/js/instrumentation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Instrumentation"
title: Instrumentation
weight: 3
---

Expand Down Expand Up @@ -32,7 +32,9 @@ function doWork() {

## Creating Spans

As you have learned in the previous [Getting Started](../getting_started/) guide you need a TracerProvider and an Exporter. Install the dependencies and add them to head of your application code to get started:
As you have learned in the previous [Getting Started][] guide you need a
TracerProvider and an Exporter. Install the dependencies and add them to the head of
your application code to get started:

```shell
npm install @opentelemetry/sdk-trace-base
Expand Down Expand Up @@ -195,3 +197,5 @@ function doWork(parent) {
span.end();
}
```

[Getting Started]: {{< relref "getting-started" >}}