You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by wa...@apache.org on 2022/05/19 06:45:57 UTC
[incubator-devlake-website] branch main updated (030b8f4 -> ac653a2)
This is an automated email from the ASF dual-hosted git repository.
warren pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
from 030b8f4 docs: add some snapshot for plugin config (#26)
new 3b7a04b fix: compoent perspective architecture diagram
new ac653a2 fix: jira doc syntax
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/01-Overview/02-Architecture.md | 2 ++
docs/03-Plugins/jira.md | 29 +++++++++++++++--------------
static/img/arch-component.svg | 5 ++++-
3 files changed, 21 insertions(+), 15 deletions(-)
[incubator-devlake-website] 01/02: fix: compoent perspective architecture diagram
Posted by wa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
warren pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 3b7a04bf1c470b083bbd4dfb31511269f0e1952e
Author: Klesh Wong <zh...@merico.dev>
AuthorDate: Thu May 19 12:32:19 2022 +0800
fix: compoent perspective architecture diagram
---
docs/01-Overview/02-Architecture.md | 2 ++
static/img/arch-component.svg | 5 ++++-
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/docs/01-Overview/02-Architecture.md b/docs/01-Overview/02-Architecture.md
index ae00b83..f3330e2 100755
--- a/docs/01-Overview/02-Architecture.md
+++ b/docs/01-Overview/02-Architecture.md
@@ -8,6 +8,8 @@ description: >
<p align="center">Architecture Diagram (data-flow perspective)</p>
+
+<p align="center">Architecture Diagram (component perspective)</p>
## Stack (from low to high)
diff --git a/static/img/arch-component.svg b/static/img/arch-component.svg
index d6cc93a..5f9daa8 100644
--- a/static/img/arch-component.svg
+++ b/static/img/arch-component.svg
@@ -1 +1,4 @@
-<mxfile host="Electron" modified="2022-05-12T09:41:06.154Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/17.4.2 Chrome/100.0.4896.60 Electron/18.0.1 Safari/537.36" etag="6vSd5RCrgC3i_NVkrfRo" version="17.4.2" type="device"><diagram id="rbQhRwd4xvFo_47z7uvu" name="Page-1">3VjdbpswGH2aSNtFI8CBJJdr0m6TWq0ampb2ZnKCC24dzIxJwp5+JrYhYNKlStJkvcI+fP7hnOPPNh0wmq8+M5hEtzRApONYwaoDxh3HsYcDTzwKJJfI0O5LIGQ4UEEV4OM/SIGWQjMcoLQWyCklHCd1cEbjGM14DYOM0WU97JGS+qgJDJEB+DNITPQ [...]
\ No newline at end of file
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Do not edit this file with editors other than diagrams.net -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="711px" height="271px" viewBox="-0.5 -0.5 711 271" content="<mxfile host="Electron" modified="2022-05-19T04:29:17.263Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/18.0.1 Chrome/100.0.4896.143 Electron/18.2.0 Safari/537.36" etag="Gl3qT091Rh7o-7RdCQlT" version="18.0.1" type="device"><di [...]
\ No newline at end of file
[incubator-devlake-website] 02/02: fix: jira doc syntax
Posted by wa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
warren pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit ac653a27112257d9f2f24df3b48ea5fd993fd0ca
Author: Klesh Wong <zh...@merico.dev>
AuthorDate: Thu May 19 14:44:22 2022 +0800
fix: jira doc syntax
---
docs/03-Plugins/jira.md | 29 +++++++++++++++--------------
1 file changed, 15 insertions(+), 14 deletions(-)
diff --git a/docs/03-Plugins/jira.md b/docs/03-Plugins/jira.md
index 6fb47e1..0ffb1b0 100644
--- a/docs/03-Plugins/jira.md
+++ b/docs/03-Plugins/jira.md
@@ -9,22 +9,22 @@ description: >
This plugin collects Jira data through Jira Cloud REST API. It then computes and visualizes various engineering metrics from the Jira data.
-<img width="2035" alt="jira metric display" src="https://user-images.githubusercontent.com/2908155/132926143-7a31d37f-22e1-487d-92a3-cf62e402e5a8.png">
+<img width="2035" alt="jira metric display" src="https://user-images.githubusercontent.com/2908155/132926143-7a31d37f-22e1-487d-92a3-cf62e402e5a8.png" />
## Project Metrics This Covers
-| Metric Name | Description |
-|:------------------------------------|:-----------------------------------------------------------------------------------------------|
-| Requirement Count | Number of issues with type "Requirement" |
-| Requirement Lead Time | Lead time of issues with type "Requirement" |
-| Requirement Delivery Rate | Ratio of delivered requirements to all requirements |
-| Requirement Granularity | Number of story points associated with an issue |
-| Bug Count | Number of issues with type "Bug"<br><i>bugs are found during testing</i> |
-| Bug Age | Lead time of issues with type "Bug"<br><i>both new and deleted lines count</i> |
-| Bugs Count per 1k Lines of Code | Amount of bugs per 1000 lines of code |
-| Incident Count | Number of issues with type "Incident"<br><i>incidents are found when running in production</i> |
-| Incident Age | Lead time of issues with type "Incident" |
-| Incident Count per 1k Lines of Code | Amount of incidents per 1000 lines of code |
+| Metric Name | Description |
+|:------------------------------------|:--------------------------------------------------------------------------------------------------|
+| Requirement Count | Number of issues with type "Requirement" |
+| Requirement Lead Time | Lead time of issues with type "Requirement" |
+| Requirement Delivery Rate | Ratio of delivered requirements to all requirements |
+| Requirement Granularity | Number of story points associated with an issue |
+| Bug Count | Number of issues with type "Bug"<br/><i>bugs are found during testing</i> |
+| Bug Age | Lead time of issues with type "Bug"<br/><i>both new and deleted lines count</i> |
+| Bugs Count per 1k Lines of Code | Amount of bugs per 1000 lines of code |
+| Incident Count | Number of issues with type "Incident"<br/><i>incidents are found when running in production</i> |
+| Incident Age | Lead time of issues with type "Incident" |
+| Incident Count per 1k Lines of Code | Amount of incidents per 1000 lines of code |
## Configuration
@@ -227,7 +227,8 @@ Your board id is used in all REST requests to Apache DevLake. You do not need to
5. API forwarding
For example:
-Requests to http://your_devlake_host/plugins/jira/connections/1/proxy/rest/agile/1.0/board/8/sprint would forward to https://your_jira_host/rest/agile/1.0/board/8/sprint
+Requests to `http://your_devlake_host/plugins/jira/connections/1/proxy/rest/agile/1.0/board/8/sprint`
+would be forwarded to `https://your_jira_host/rest/agile/1.0/board/8/sprint`
```GET /plugins/jira/connections/:connectionId/proxy/rest/*path
{