Skip to content

Commit

Permalink
Cross-link Error Tracking documentation (#22786)
Browse files Browse the repository at this point in the history
* Prevent jumps from tracing ET docs to top-level ET docs

* Add fix for page nav in include-markdown

* Prevent jumps to top-level ET docs from Logs and RUM ET docs

* Add supported products to top-level error tracking docs

* Add Roku to Error Tracking docs links
  • Loading branch information
jhgilbert authored Apr 23, 2024
1 parent f8ffcbc commit 2420981
Show file tree
Hide file tree
Showing 19 changed files with 138 additions and 22 deletions.
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
i18n/*.json
i18n/*.json
layouts/partials/table-of-contents/**/*.html
33 changes: 24 additions & 9 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1781,6 +1781,21 @@ menu:
parent: error_tracking
identifier: error_tracking_suspect_commits
weight: 3
- name: APM
url: error_tracking/apm
parent: error_tracking
identifier: error_tracking_apm
weight: 4
- name: Logs
url: error_tracking/logs
parent: error_tracking
identifier: error_tracking_logs
weight: 5
- name: Real User Monitoring
url: error_tracking/rum
parent: error_tracking
identifier: error_tracking_rum
weight: 6
- name: Service Level Objectives
url: service_management/service_level_objectives/
pre: slos
Expand Down Expand Up @@ -2884,17 +2899,17 @@ menu:
identifier: tracing_error_tracking
weight: 10
- name: Error Tracking Explorer
url: error_tracking/explorer
url: tracing/error_tracking/explorer
parent: tracing_error_tracking
identifier: tracing_error_tracking_explorer
weight: 1001
- name: Custom Grouping
url: error_tracking/custom_grouping
url: tracing/error_tracking/custom_grouping
parent: tracing_error_tracking
identifier: tracing_error_tracking_custom_grouping
weight: 1002
- name: Identify Suspect Commits
url: error_tracking/suspect_commits
url: tracing/error_tracking/suspect_commits
parent: tracing_error_tracking
identifier: tracing_error_tracking_suspect_commits
weight: 1003
Expand Down Expand Up @@ -4093,7 +4108,7 @@ menu:
identifier: log_management_error_tracking
weight: 6
- name: Error Tracking Explorer
url: error_tracking/explorer
url: logs/error_tracking/explorer
parent: log_management_error_tracking
identifier: log_management_error_tracking_explorer
weight: 601
Expand All @@ -4108,7 +4123,7 @@ menu:
parent: log_management_error_tracking
weight: 603
- name: Custom Grouping
url: error_tracking/custom_grouping
url: logs/error_tracking/custom_grouping
parent: log_management_error_tracking
identifier: log_management_error_tracking_custom_grouping
weight: 604
Expand All @@ -4118,7 +4133,7 @@ menu:
identifier: log_management_error_tracking_manage_data_collection
weight: 605
- name: Identify Suspect Commits
url: error_tracking/suspect_commits
url: logs/error_tracking/suspect_commits
parent: log_management_error_tracking
identifier: log_management_error_tracking_suspect_commits
weight: 606
Expand Down Expand Up @@ -5155,7 +5170,7 @@ menu:
identifier: rum_error_tracking
weight: 11
- name: Explorer
url: error_tracking/explorer/
url: real_user_monitoring/error_tracking/explorer/
parent: rum_error_tracking
identifier: rum_error_tracking_explorer
weight: 1101
Expand All @@ -5170,12 +5185,12 @@ menu:
identifier: rum_error_tracking_mobile
weight: 1103
- name: Custom Grouping
url: error_tracking/custom_grouping
url: real_user_monitoring/error_tracking/custom_grouping
parent: rum_error_tracking
identifier: rum_error_tracking_custom_grouping
weight: 1104
- name: Identify Suspect Commits
url: error_tracking/suspect_commits
url: real_user_monitoring/error_tracking/suspect_commits
parent: rum_error_tracking
identifier: rum_error_tracking_suspect_commits
weight: 1105
Expand Down
11 changes: 11 additions & 0 deletions content/en/error_tracking/apm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Error Tracking for APM
kind: documentation
---

Error Tracking is available for all the languages supported by APM and does not require using a different SDK.

{{< whatsnext desc="Get started with Error Tracking for APM:" >}}
{{< nextlink href="tracing/error_tracking" >}}View the documentation{{< /nextlink >}}
{{< nextlink href="tracing/error_tracking/#setup" >}}Set up the optional source code integration{{< /nextlink >}}
{{< /whatsnext >}}
4 changes: 0 additions & 4 deletions content/en/error_tracking/custom_grouping.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
title: Custom Grouping
kind: documentation
description: Customize how error spans are grouped into issues.
aliases:
- /logs/error_tracking/custom_grouping
- /real_user_monitoring/error_tracking/custom_grouping
- /tracing/error_tracking/custom_grouping
---

## Overview
Expand Down
4 changes: 0 additions & 4 deletions content/en/error_tracking/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ further_reading:
- link: '/monitors/types/error_tracking'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'
aliases:
- /real_user_monitoring/error_tracking/explorer
- /logs/error_tracking/explorer
- /tracing/error_tracking/explorer
---

## Overview
Expand Down
9 changes: 9 additions & 0 deletions content/en/error_tracking/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Error Tracking for Logs
kind: documentation
---

{{< whatsnext desc="To get started with Error Tracking for Logs, see the corresponding documentation for your framework:" >}}
{{< nextlink href="logs/error_tracking/browser_and_mobile" >}}Browser and Mobile{{< /nextlink >}}
{{< nextlink href="logs/error_tracking/backend" >}}Backend{{< /nextlink >}}
{{< /whatsnext >}}
14 changes: 14 additions & 0 deletions content/en/error_tracking/rum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Error Tracking for Web and Mobile Applications
kind: documentation
---

{{< whatsnext desc="To get started with Datadog Error Tracking for RUM, see the corresponding documentation:" >}}
{{< nextlink href="real_user_monitoring/error_tracking/browser" >}}Browser{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/android" >}}Android{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/ios" >}}iOS{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/expo" >}}Expo{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/reactnative" >}}React Native{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/flutter" >}}Flutter{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/roku" >}}Roku{{< /nextlink >}}
{{< /whatsnext >}}
2 changes: 0 additions & 2 deletions content/en/error_tracking/suspect_commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Suspect Commits
kind: documentation
disable_toc: false
aliases:
- /logs/error_tracking/suspect_commits
---
## Overview

Expand Down
7 changes: 7 additions & 0 deletions content/en/logs/error_tracking/custom_grouping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Custom Grouping
kind: documentation
description: Customize how error spans are grouped into issues.
---

{{< include-markdown "content/en/error_tracking/custom_grouping.md" >}}
11 changes: 11 additions & 0 deletions content/en/logs/error_tracking/explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Error Tracking Explorer
kind: documentation
description: Learn about the Error Tracking Explorer.
further_reading:
- link: '/monitors/types/error_tracking'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'
---

{{< include-markdown "content/en/error_tracking/explorer.md" >}}
7 changes: 7 additions & 0 deletions content/en/logs/error_tracking/suspect_commits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Suspect Commits
kind: documentation
disable_toc: false
---

{{< include-markdown "content/en/error_tracking/suspect_commits.md" >}}
3 changes: 2 additions & 1 deletion content/en/real_user_monitoring/error_tracking/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,14 @@ Take a tour of key Error Tracking features in the [Error Tracking Explorer][3] d

## Setup

{{< whatsnext desc="To get started with Datadog Error Tracking for RUM, see the corresponding documentation to upload source maps for your framework:" >}}
{{< whatsnext desc="To get started with Datadog Error Tracking for RUM, see the corresponding documentation:" >}}
{{< nextlink href="real_user_monitoring/error_tracking/browser" >}}Browser{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/android" >}}Android{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/ios" >}}iOS{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/expo" >}}Expo{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/reactnative" >}}React Native{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/flutter" >}}Flutter{{< /nextlink >}}
{{< nextlink href="real_user_monitoring/error_tracking/roku" >}}Roku{{< /nextlink >}}
{{< /whatsnext >}}

## Further Reading
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Custom Grouping
kind: documentation
description: Customize how error spans are grouped into issues.
---

{{< include-markdown "content/en/error_tracking/custom_grouping.md" >}}
11 changes: 11 additions & 0 deletions content/en/real_user_monitoring/error_tracking/explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Error Tracking Explorer
kind: documentation
description: Learn about the Error Tracking Explorer.
further_reading:
- link: '/monitors/types/error_tracking'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'
---

{{< include-markdown "content/en/error_tracking/explorer.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Suspect Commits
kind: documentation
disable_toc: false
---

{{< include-markdown "content/en/error_tracking/suspect_commits.md" >}}
7 changes: 7 additions & 0 deletions content/en/tracing/error_tracking/custom_grouping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Custom Grouping
kind: documentation
description: Customize how error spans are grouped into issues.
---

{{< include-markdown "content/en/error_tracking/custom_grouping.md" >}}
11 changes: 11 additions & 0 deletions content/en/tracing/error_tracking/explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Error Tracking Explorer
kind: documentation
description: Learn about the Error Tracking Explorer.
further_reading:
- link: '/monitors/types/error_tracking'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'
---

{{< include-markdown "content/en/error_tracking/explorer.md" >}}
7 changes: 7 additions & 0 deletions content/en/tracing/error_tracking/suspect_commits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Suspect Commits
kind: documentation
disable_toc: false
---

{{< include-markdown "content/en/error_tracking/suspect_commits.md" >}}
2 changes: 1 addition & 1 deletion layouts/partials/table-of-contents/table-of-contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</ul>
</nav>
{{ else }}
{{ if in .RawContent "{{< site-region" }}
{{ if or (in .RawContent "{{< site-region") (in .RawContent "{{< include-markdown") }}
{{ partial "table-of-contents/scraped-toc.html" . }}
{{ else }}
{{ .TableOfContents }}
Expand Down

0 comments on commit 2420981

Please sign in to comment.