Teddy.gesbert/doc dora #28783
Teddy.gesbert/doc dora #28783
Conversation
Co-authored-by: Jorge Calvar <[email protected]>
Change deployment.merge_time to Merge Time (i.e. metric to field) to avoid any confusion with previous Metrics type
…tion into teddy.gesbert/doc-dora
Applied suggestions from Joe Peeples
Preview links (active after the
|
There was a problem hiding this comment.
Hi @Tecoddy looks good just a few minor suggestions for consistency, let me know when this is ready for re-review.
Also I don't think the alias is needed. But doesn't hurt to leave it either.
Co-authored-by: Alicia Scott <[email protected]>
Co-authored-by: Alicia Scott <[email protected]>
- Added consistency between data sources requirements. - Remove /dora_metrics/failures/datadog_incidents alias as not needed.
|
Hi @aliciascott, thank you for your review and your suggestions! It is now ready for re-review. |
There was a problem hiding this comment.
Hi @Tecoddy just a couple small things then it should be good to go!
| @@ -39,12 +39,34 @@ Failed deployment events, currently interpreted through failure events, are used | |||
| ## Selecting and configuring a failure data source | |||
|
|
|||
| {{< tabs >}} | |||
| {{% tab "Datadog Incidents" %}} | |||
| DORA Metrics can automatically identify and track failures through [Datadog Incidents][201]. Once incidents are declared, DORA uses them to measure change failure rate and time to restore. | |||
There was a problem hiding this comment.
| DORA Metrics can automatically identify and track failures through [Datadog Incidents][201]. Once incidents are declared, DORA uses them to measure change failure rate and time to restore. | |
| DORA Metrics can automatically identify and track failures through [Datadog Incidents][201]. Once incidents are declared, DORA uses them to measure change failure rate and Time to Restore. |
There was a problem hiding this comment.
Do we really want to have it in uppercase? All of the four DORA metrics (deployment frequency, change lead time, change failure rate, time to restore) are mentioned in lowercase throughout the DORA doc.
There was a problem hiding this comment.
I noticed it was capitalized throughout so wanted it to be consistent, either way is fine depending on how it is in the app, but just should be consistent in the doc :)
There was a problem hiding this comment.
Agreed, hadn't notice it was capitalized right below. Thanks for pointing this out!
Updated it.
Co-authored-by: Alicia Scott <[email protected]>
|
/merge |
|
View all feedbacks in Devflow UI.
This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
The expected merge time in
|
dd-devflow
bot
added
mergequeue-status: done
and removed
mergequeue-status: in_progress
labels
* Replaced incidents by failures * v1 * v1.1 * Little update of some requirements (DORA settings) * Upper case small changes * Update content/en/dora_metrics/data_collected/_index.md Co-authored-by: Jorge Calvar <[email protected]> * Applied feedback from Jorge Change deployment.merge_time to Merge Time (i.e. metric to field) to avoid any confusion with previous Metrics type * Applied feedback from Guillaume * Fix typos and improve consistency in DORA metrics documentation Applied suggestions from Joe Peeples * Applying Joe's feedback and fixing small tweak * Added Incident Management as a DORA Failure data source * Update content/en/dora_metrics/setup/failures.md Co-authored-by: Alicia Scott <[email protected]> * Update content/en/dora_metrics/setup/failures.md Co-authored-by: Alicia Scott <[email protected]> * Applied feedback from alicia - Added consistency between data sources requirements. - Remove /dora_metrics/failures/datadog_incidents alias as not needed. * Applied feedback from Jorge * Update content/en/dora_metrics/setup/failures.md Co-authored-by: Alicia Scott <[email protected]> * Update failures.md --------- Co-authored-by: Jorge Calvar <[email protected]> Co-authored-by: Alicia Scott <[email protected]>
What does this PR do? What is the motivation?
We just integrated Datadog Incident Management as a new Failures data source for DORA Metrics. This PR aims to give guidance on how to set up this new data source in DORA Metrics.
Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes