Skip to content

Commit e4974f6

Browse files
committed
doc: Update Docker Repository address everywhere
1 parent e8220c5 commit e4974f6

File tree

3 files changed

+129
-58
lines changed

3 files changed

+129
-58
lines changed

README-CH.md

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
[![Release](https://img.shields.io/github/v/release/thoughtworks/metrik.svg?include_prereleases&style=flat)](https://github.com/thoughtworks/metrik/releases)
1313

1414
*多语言支持:* [English](README.md), [简体中文](README-CH.md)
15-
*GitHub 仓库:* [https://github.com/thoughtworks/metrik](https://github.com/thoughtworks/metrik)
15+
*GitHub 仓库:* [https://github.com/thoughtworks/metrik](https://github.com/thoughtworks/metrik)
1616

1717
<!-- PROJECT TITLE -->
1818
<h1 align="center">
@@ -46,19 +46,23 @@
4646
<!-- END OF PROJECT TITLE -->
4747

4848
<!-- ABOUT THE PROJECT -->
49+
4950
## 关于本项目
51+
5052
对于想要衡量其软件交付和运营(SDO)效能的开发团队来说,本项目是一个帮助他们从CD管道收集数据并以友好的可视化方式展示关键指标的工具。
5153

5254
**关键差异化因素:**
55+
5356
* 单页配置,简单易用.
5457
* 具有跨多个CD平台工作的能力.
5558
* 用户可以自行选择要分析的环境(是的,生产环境不是唯一重要的环境)。
5659

5760
[不知道什么是四个关键指标?](https://www.thoughtworks.com/radar/techniques/four-key-metrics)
5861

59-
6062
### 集成路线
63+
6164
产品现在支持/计划支持的CD工具清单
65+
6266
- [x] Jenkins
6367
- [x] Bamboo
6468
- [x] Github Actions
@@ -71,35 +75,43 @@
7175

7276

7377
<!-- USAGE -->
78+
7479
## 用法
80+
7581
按照以下两个步骤来运行该工具,并测量你的项目的四个关键指标。
7682

7783
### 安装和运行
7884

79-
该产品被发布到ECR Docker仓库`public.ecr.aws/j2s5d3z8/4-key-metrics`。请按照以下步骤操作。
85+
该产品被发布到Docker Hub仓库`docker.io/wszzwpshh1/metrik`。请按照以下步骤操作。
86+
8087
1. 确保[Docker](https://www.docker.com)已经安装在你的操作系统上。
8188
2. 在发布页中查找可用的[已发布版本](https://github.com/thoughtworks/metrik/releases)
82-
或者,你可以从我们的[镜像库]中找到所有的历史版本(https://gallery.ecr.aws/j2s5d3z8/4-key-metrics)
89+
或者,你可以从我们的[镜像库]中找到所有的历史版本(https://hub.docker.com/r/wszzwpshh1/metrik)
8390
3. 通过以下命令在本地运行该容器:
91+
8492
``` bash
85-
docker run -d -p 80:80 --name metrik public.ecr.aws/j2s5d3z8/4-key-metrics:latest
93+
docker run -d -p 80:80 --name metrik wszzwpshh1/metrik:latest
8694
```
87-
*⚠️ 我们使用80端口来访问该应用程序。如果80端口被你机器上运行的其他应用程序占用,你可以切换到任何其他端口。
88-
*⚠️ `latest`标签匹配该仓库的最新版本。因此,使用 public.ecr.aws/j2s5d3z8/4-key-metrics:latest 或 public.ecr.aws/j2s5d3z8/4-key-metrics 将确保你运行的是这个镜像的最新版本*
89-
如果你想使用一个特定的版本标签,请记住版本名称中没有 "v"。例如,public.ecr.aws/j2s5d3z8/4-key-metrics:1.1.10
9095

96+
*⚠️ 我们使用80端口来访问该应用程序。如果80端口被你机器上运行的其他应用程序占用,你可以切换到任何其他端口。
97+
*⚠️ `latest`标签匹配该仓库的最新版本。因此,使用 wszzwpshh1/metrik:latest 或 wszzwpshh1/metrik
98+
将确保你运行的是这个镜像的最新版本*
99+
如果你想使用一个特定的版本标签,请记住版本名称中没有 "v"。例如,wszzwpshh1/metrik:1.1.10
91100

92101
### 配置
93102

94103
容器在你的机器上运行后。进入你最喜欢的浏览器并打开该应用程序。如果在本地运行,那就是`http://localhost:80/`
95104

96105
1. 开始配置:
106+
97107
<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step1.png" height=70% width=70%></div>
98108

99109
2. 随后每个关键指标的图表将出现在主页面上:
110+
100111
<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step2.png" height=70% width=70%></div>
101112

102113
3. 如果你想把它放在大屏幕上,还可以全屏观看:
114+
103115
<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step3.png" height=70% width=70%></div>
104116

105117
### 高级用法
@@ -108,62 +120,80 @@ docker run -d -p 80:80 --name metrik public.ecr.aws/j2s5d3z8/4-key-metrics:lates
108120
可以把数据库文件夹`/data/db`挂载出来。如果你挂载日志文件夹`/app/logs`,那么日志也会被保存。如下面的例子所示。
109121

110122
``` bash
111-
docker run -d -p 80:80 --name metrik -v "/path/to/local/directory:/data/db" -v "/path/to/another/directory:/app/logs" public.ecr.aws/j2s5d3z8/4-key-metrics:${release_version}
123+
docker run -d -p 80:80 --name metrik -v "/path/to/local/directory:/data/db" -v "/path/to/another/directory:/app/logs" wszzwpshh1/metrik:${release_version}
112124
```
125+
113126
<!-- END OF USAGE -->
114127

115128

116129
<!-- HOW TO COMPUTE -->
130+
117131
## 算法
118-
[详细算法请参考Wiki页面](https://github.com/thoughtworks/metrik/wiki)
132+
133+
[详细算法请参考Wiki页面](https://github.com/thoughtworks/metrik/wiki)
119134
<!-- END OF HOW TO COMPUTE -->
120135

121136

122137
<!-- CONTRIBUTING -->
138+
123139
## 贡献
140+
124141
贡献是使开源社区成为一个学习、激励和创造的神奇场所的原因。我们真诚的感谢你所做的任何类型的贡献.
125142

126143
请在[这里](https://github.com/thoughtworks/metrik/blob/main/CONTRIBUTING.md)查看我们的贡献者指南。
127144
<!-- END OF CONTRIBUTING -->
128145

129146

130147
<!-- GETTING STARTED -->
148+
131149
## 快速开始
150+
132151
该代码库由三个主要部分组成:"前端"、"后端 "和 "CI"。
152+
133153
* 前端应用由以下技术栈构建:
134-
* TypeScript
135-
* ReactJS
136-
* ReCharts
154+
* TypeScript
155+
* ReactJS
156+
* ReCharts
137157

138158
可以在[前端文件夹](https://github.com/thoughtworks/metrik/tree/main/frontend)找到更多细节。
139159

140160
* 后端程序由以下技术栈构建:
141-
* Kotlin
142-
* Spring Boot Web
143-
* MongoDB
161+
* Kotlin
162+
* Spring Boot Web
163+
* MongoDB
144164

145165
可以在[后端文件夹](https://github.com/thoughtworks/metrik/tree/main/backend)找到更多细节。
146-
166+
147167
* 构建/打包的脚本在[CI文件夹](https://github.com/thoughtworks/metrik/tree/main/ci)下。
168+
148169
<!-- END OF GETTING STARTED -->
149170

150171

151172
<!-- MORE -->
173+
152174
## 更多
175+
153176
你可能会感兴趣的类似项目:
177+
154178
* [Buildvis](https://github.com/cburgmer/buildviz), transparency for your build pipeline's results and runtime
155-
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
156-
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD instance.
179+
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision
180+
control and project planning tools.
181+
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD
182+
instance.
183+
157184
<!-- END OF MORE -->
158185

159186

160187
<!-- LICENSE -->
188+
161189
## License
190+
162191
在MIT许可下发布。更多信息见[LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt)
163192
<!-- END OF LICENSE -->
164193

165194

166195
<!-- CONTRIBUTORS -->
196+
167197
## Contributors ✨
168198

169199
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -232,4 +262,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
232262

233263
<!-- ALL-CONTRIBUTORS-LIST:END -->
234264

235-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
265+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
266+
Contributions of any kind welcome!

README.md

Lines changed: 65 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,25 @@
4242
<!-- END OF PROJECT TITLE -->
4343

4444
<!-- ABOUT THE PROJECT -->
45+
4546
## About the Project
46-
For development teams who wants to measure their software delivery and operational (SDO) performance, this is a tool that helps them collect data from CD pipelines and visualize the key metrics in a friendly format.
47+
48+
For development teams who wants to measure their software delivery and operational (SDO) performance, this is a tool
49+
that helps them collect data from CD pipelines and visualize the key metrics in a friendly format.
4750

4851
**The key differentiators:**
52+
4953
* One page configuration, quick and easy.
5054
* The ability to work across different CD platforms.
51-
* User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the only one that matters)
55+
* User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the
56+
only one that matters)
5257

5358
[Don't know what are those four key metrics?](https://www.thoughtworks.com/radar/techniques/four-key-metrics)
5459

55-
5660
### Integration roadmap
61+
5762
List of CD tools the product supports now/plan to support
63+
5864
- [x] Jenkins
5965
- [x] Bamboo
6066
- [x] GitHub Actions
@@ -67,99 +73,132 @@ List of CD tools the product supports now/plan to support
6773

6874

6975
<!-- USAGE -->
76+
7077
## Usage
78+
7179
Follow the two steps below to run the tool, and measure the four key metrics of your projects.
7280

7381
### Install and run
7482

75-
The product is released to an ECR Docker repository `public.ecr.aws/j2s5d3z8/4-key-metrics`. Please follow the steps:
83+
The product is released to a public repository hosted on Docker Hub `docker.io/wszzwpshh1/metrik`. Please follow the
84+
steps:
85+
7686
1. Ensure [Docker](https://www.docker.com) has already installed on your OS.
7787
2. Find available [release versions](https://github.com/thoughtworks/metrik/releases) in the release page.
78-
Or, you can find all history versions from our [image repository](https://gallery.ecr.aws/j2s5d3z8/4-key-metrics)
88+
Or, you can find all history versions from our [image repository](https://hub.docker.com/r/wszzwpshh1/metrik)
7989
3. Run the container locally via the following command:
90+
8091
``` bash
81-
docker run -d -p 80:80 --name metrik public.ecr.aws/j2s5d3z8/4-key-metrics:latest
92+
docker run -d -p 80:80 --name metrik docker.io/wszzwpshh1/metrik:latest
8293
```
83-
*⚠️ We use port 80 to access the app. You may switch to any other port in case port 80 is occupied by other apps running on your machine.*
84-
*⚠️ The `latest` tag matches the most recent version of this repository. Thus using public.ecr.aws/j2s5d3z8/4-key-metrics:latest or public.ecr.aws/j2s5d3z8/4-key-metrics will ensure you are running the most up to date version of this image.*
85-
If you want to stick to a specific version tag, remember there no "v" in version name. e.g. public.ecr.aws/j2s5d3z8/4-key-metrics:1.1.10
8694

95+
*⚠️ We use port 80 to access the app. You may switch to any other port in case port 80 is occupied by other apps running
96+
on your machine.*
97+
*⚠️ The `latest` tag matches the most recent version of this repository. Thus using wszzwpshh1/metrik:latest or
98+
wszzwpshh1/metrik will ensure you are running the most up to date version of this image.*
99+
If you want to stick to a specific version tag, remember there no "v" in version name. e.g. wszzwpshh1/metrik:latest:
100+
1.6.5
87101

88102
### Configure your projects
89103

90-
After the container is running on your machine. Go to your favourite browser and open the app. If running in local that would be `http://localhost:80/`.
104+
After the container is running on your machine. Go to your favourite browser and open the app. If running in local that
105+
would be `http://localhost:80/`.
91106

92107
1. Start the configuration:
108+
93109
<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step1.png" height=70% width=70%></div>
94110

95111
2. And the charts for each key metric will be available at the main page:
112+
96113
<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step2.png" height=70% width=70%></div>
97114

98115
3. Also the full screen view if you want to put it on big screens:
116+
99117
<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step3.png" height=70% width=70%></div>
100118

101119
### Advanced usage
102120

103121
If you would like to keep the 4-key-metrics data to avoid losing any data when remove container, you
104-
can mount the database folder `/data/db` out. And logs are also available if you mount the log folder `/app/logs`. As shown in the example below:
122+
can mount the database folder `/data/db` out. And logs are also available if you mount the log folder `/app/logs`. As
123+
shown in the example below:
105124

106125
``` bash
107-
docker run -d -p 80:80 --name metrik -v "/path/to/local/directory:/data/db" -v "/path/to/another/directory:/app/logs" public.ecr.aws/j2s5d3z8/4-key-metrics:${release_version}
126+
docker run -d -p 80:80 --name metrik -v "/path/to/local/directory:/data/db" -v "/path/to/another/directory:/app/logs" wszzwpshh1/metrik:${release_version}
108127
```
128+
109129
<!-- END OF USAGE -->
110130

111131

112132
<!-- Our Wiki -->
133+
113134
## How to Compute, FAQs
114-
[See our Wiki page](https://github.com/thoughtworks/metrik/wiki)
135+
136+
[See our Wiki page](https://github.com/thoughtworks/metrik/wiki)
115137
<!-- END OF HOW TO COMPUTE -->
116138

117139

118140
<!-- CONTRIBUTING -->
141+
119142
## Contributing
120-
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
143+
144+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any
145+
contributions you make are **greatly appreciated**.
121146

122147
Please check our contributing guideline form [HERE](CONTRIBUTING.md)
123148
<!-- END OF CONTRIBUTING -->
124149

125150

126151
<!-- GETTING STARTED -->
152+
127153
## Getting Started
154+
128155
The codebase comprises of three major components `frontend`, `backend`, `ci`.
156+
129157
* Frontend app is a web application built with:
130-
* TypeScript
131-
* ReactJS
132-
* ReCharts
158+
* TypeScript
159+
* ReactJS
160+
* ReCharts
133161

134162
Go to [frontend folder](https://github.com/thoughtworks/metrik/tree/main/frontend) to find more details.
135163

136164
* Backend app is built with:
137-
* Kotlin
138-
* Spring Boot Web
139-
* MongoDB
165+
* Kotlin
166+
* Spring Boot Web
167+
* MongoDB
140168

141169
Go to [backend folder](https://github.com/thoughtworks/metrik/tree/main/backend) to find more details.
142-
170+
143171
* Build/Package scripts lives in [ci folder](https://github.com/thoughtworks/metrik/tree/main/ci)
172+
144173
<!-- END OF GETTING STARTED -->
145174

146175

147176
<!-- MORE -->
177+
148178
## More
179+
149180
You might also like:
181+
150182
* [Buildvis](https://github.com/cburgmer/buildviz), transparency for your build pipeline's results and runtime
151-
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
152-
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD instance.
183+
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision
184+
control and project planning tools.
185+
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD
186+
instance.
187+
153188
<!-- END OF MORE -->
154189

155190

156191
<!-- LICENSE -->
192+
157193
## License
158-
Distributed under the MIT License. See [LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt) for more information
194+
195+
Distributed under the MIT License. See [LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt) for more
196+
information
159197
<!-- END OF LICENSE -->
160198

161199

162200
<!-- CONTRIBUTORS -->
201+
163202
## Contributors ✨
164203

165204
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -228,4 +267,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
228267

229268
<!-- ALL-CONTRIBUTORS-LIST:END -->
230269

231-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
270+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
271+
Contributions of any kind welcome!

0 commit comments

Comments
 (0)