This is an automated email from the ASF dual-hosted git repository.
abeizn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new c2ebaf20f7 docs: polish fdrt docs (#734)
c2ebaf20f7 is described below
commit c2ebaf20f72aa6754e8b7a470c805f827dfff963
Author: Louis.z <[email protected]>
AuthorDate: Fri Mar 15 20:40:06 2024 +0800
docs: polish fdrt docs (#734)
Co-authored-by: Startrekzky <[email protected]>
---
docs/Configuration/images/fdrt.png | Bin 0 -> 124584 bytes
docs/DORA.md | 7 ++++---
docs/Metrics/FailedDeploymentRecoveryTime.md | 16 ++++++++++------
3 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/docs/Configuration/images/fdrt.png
b/docs/Configuration/images/fdrt.png
new file mode 100644
index 0000000000..89c9080d42
Binary files /dev/null and b/docs/Configuration/images/fdrt.png differ
diff --git a/docs/DORA.md b/docs/DORA.md
index 114a52fdd7..7ddebfced8 100644
--- a/docs/DORA.md
+++ b/docs/DORA.md
@@ -20,11 +20,12 @@ Within velocity are two core metrics:
- [Deployment Frequency](./Metrics/DeploymentFrequency.md): Number of
successful deployments to production, how rapidly is your team releasing to
users?
- [Lead Time for Changes](./Metrics/LeadTimeForChanges.md): How long does it
take from commit to the code running in production? This is important, as it
reflects how quickly your team can respond to user requirements.
-Stability is composed of some core metrics:
+Stability is composed of two core metrics:
- [Change Failure Rate](./Metrics/CFR.md): How often are your deployments
causing a failure?
-- [Median Time to Restore Service (2021 dora report)](./Metrics/MTTR.md): How
long does it take the team to properly recover from a failure once it is
identified?
-- [Failed Deployment Recovery Time (2023 dora
report)](./Metrics/FailedDeploymentRecoveryTime.md): How long does it take from
the time of deployment to the resolution of the incident associated with the
deployment?
+- [Median Time to Restore Service (MTTR)](./Metrics/MTTR.md): How long does it
take the team to properly recover from a failure once it is identified?
+
+However, MTTR is replaced by [Failed Deployment Recovery
Time](./Metrics/FailedDeploymentRecoveryTime.md) from the 2023 DORA report.
This metric measures the finish time of a deployment to the resolution of the
incident caused by the deployment.

diff --git a/docs/Metrics/FailedDeploymentRecoveryTime.md
b/docs/Metrics/FailedDeploymentRecoveryTime.md
index e7343d4d3a..46e573b84a 100644
--- a/docs/Metrics/FailedDeploymentRecoveryTime.md
+++ b/docs/Metrics/FailedDeploymentRecoveryTime.md
@@ -7,7 +7,7 @@ sidebar_position: 28
## What is this metric?
-The Time of changes that were made to a code that then resulted in incidents,
rollbacks, or any type of production failure.
+The time of changes that were made to a code that then resulted in incidents,
rollbacks, or any type of production failure.
## Why is it important?
@@ -19,7 +19,9 @@ DORA dashboard. See [live
demo](https://grafana-lake.demo.devlake.io/grafana/d/q
## How is it calculated?
-The time from deployment to the incident corresponding to deployment is
resolved. For example, if a deployment at 10:00 AM and incident caused by
deployment is resolved at 11:00 AM, the failed deployment recovery time is one
hour.
+The time from deployment to the incident corresponding to deployment is
resolved. For example, if a deployment finishes at 10:00 AM and causes an
incident at 10:20. Then, the incident gets resolved at 11:00 AM. The failed
deployment recovery time is one hour.
+
+
Below are the 2023 DORA benchmarks for different development teams from
Google's report. However, it's difficult to tell which group a team falls into
when the team's failed deployment recovery time is `between one week and six
months`. Therefore, DevLake provides its own benchmarks to address this problem:
@@ -30,15 +32,16 @@ Below are the 2023 DORA benchmarks for different
development teams from Google's
| Medium performers | Between one day and one week | Between one day and one
week |
| Low performers | More than six months | More than one week
|
+<p><i>Source: 2023 Accelerate State of DevOps, Google</i></p>
<b>Data Sources Required</b>
-- `Deployments` from Jenkins, GitLab CI, GitHub Action, BitBucket Pipelines,
or Webhook, etc.
-- `Incidents` from Jira issues, GitHub issues, TAPD issues, PagerDuty
Incidents, etc.
+- `Deployments` from Jenkins, GitLab CI, GitHub Action, BitBucket Pipelines,
Webhook, etc.
+- `Incidents` from Jira issues, GitHub issues, TAPD issues, PagerDuty
Incidents, Webhook, etc.
<b>Transformation Rules Required</b>
-Define `deployment` and `incident` in [data
transformations](https://devlake.apache.org/docs/Configuration/Tutorial#step-3---add-transformations-optional)
while configuring the blueprint of a project to let DevLake know what CI/issue
records can be regarded as deployments or incidents.
+Define `deployment` and `incident` in [data
transformations](../Configuration/Tutorial#step-3---add-transformations-optional)
while configuring the blueprint of a project to let DevLake know what CI/issue
records can be regarded as deployments or incidents.
<b>SQL Queries</b>
@@ -198,4 +201,5 @@ WHERE
- Add unit tests for all new feature
- "Shift left", start QA early and introduce more automated tests
-- Enforce code review if it's not strictly executed
+- Enforce code review if it is not strictly executed
+- Improve your user support workflow to cope with incidents more efficiently
\ No newline at end of file