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

DOCS-7747, DOCS-7795 Adds APM Deployment Tracking Documentation #22866

Merged
merged 63 commits into from
May 16, 2024

Conversation

kassenq
Copy link
Collaborator

@kassenq kassenq commented Apr 25, 2024

What does this PR do? What is the motivation?

Releasing DORA metrics in public beta in mid-May with an integration with APM. This PR:

  • adds APM Deployment Tracking as DORA data source
  • updates page structure/navigation to support new data source pages
  • Stages a preview for the PagerDuty page (marked as TBD)

Merge instructions

  • Please merge after reviewing

Additional notes

  • Please double check capitalization for entries in Further Reading sections
  • We plan to merge this PR on Friday, May 17 when DORA Metrics goes into public beta

@alai97 alai97 changed the title Add APM Deployment Tracking as DORA data source DOCS-7795 Add APM Deployment Tracking as DORA data source Apr 25, 2024
@alai97 alai97 changed the title DOCS-7795 Add APM Deployment Tracking as DORA data source DOCS-7747, DOCS-7795 Add APM Deployment Tracking as DORA data source Apr 26, 2024
@alai97 alai97 changed the title DOCS-7747, DOCS-7795 Add APM Deployment Tracking as DORA data source DOCS-7747, DOCS-7795 Adds Data Collected, APM Deployment Tracking Documentation Apr 26, 2024
@alai97 alai97 added the WORK IN PROGRESS No review needed, it's a wip ;) label Apr 26, 2024
Comment on lines 1 to 7
---
title: Configuring PagerDuty for DORA Metrics
kind: documentation
description: Learn how to configure PagerDuty as a data source for DORA Metrics incidents.
---

TBD
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to review this page; this content will come in a separate branch.

@alai97 alai97 added the editorial review Waiting on a more in-depth review label Apr 26, 2024
@kassenq kassenq marked this pull request as ready for review April 27, 2024 18:45
@kassenq kassenq requested review from a team as code owners April 27, 2024 18:45
content/en/dora_metrics/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/apm.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/apm.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/apm.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/apm.md Outdated Show resolved Hide resolved
content/en/dora_metrics/setup/_index.md Show resolved Hide resolved
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Apr 29, 2024
@alai97 alai97 changed the title DOCS-7747, DOCS-7795 Adds Data Collected, APM Deployment Tracking Documentation DOCS-7747, DOCS-7795 Adds APM Deployment Tracking Documentation Apr 29, 2024
alai97 and others added 2 commits May 7, 2024 09:16
@alai97 alai97 removed the WORK IN PROGRESS No review needed, it's a wip ;) label May 7, 2024
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor feedback but otherwise looks good.

content/en/dora_metrics/data_collected/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/failures/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/failures/incident_api.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/_index.md Show resolved Hide resolved
content/en/dora_metrics/failures/_index.md Show resolved Hide resolved
content/en/dora_metrics/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/_index.md Outdated Show resolved Hide resolved
content/en/dora_metrics/deployments/apm.md Outdated Show resolved Hide resolved
@kassenq kassenq requested a review from rtrieu May 16, 2024 14:15
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

- link: "/dora_metrics/deployments"
tag: "Documentation"
text: "See other deployment data source options"
- link: "/continuous_integration/dora_metrics/setup/failures"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- link: "/continuous_integration/dora_metrics/setup/failures"
- link: "/dora_metrics/failures/"

- link: "/dora_metrics/deployments"
tag: "Documentation"
text: "See other deployment data source options"
- link: "/continuous_integration/dora_metrics/setup/failures"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- link: "/continuous_integration/dora_metrics/setup/failures"
- link: "/dora_metrics/failures/"

@rtrieu rtrieu merged commit f4d4e35 into master May 16, 2024
13 checks passed
@rtrieu rtrieu deleted the kassenq/dora-apm-docs branch May 16, 2024 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants