Skip to content

Commit

Permalink
doc: Update Docker Repository address everywhere
Browse files Browse the repository at this point in the history
  • Loading branch information
zhe-zhao committed Apr 8, 2024
1 parent e8220c5 commit e4974f6
Show file tree
Hide file tree
Showing 3 changed files with 129 additions and 58 deletions.
71 changes: 51 additions & 20 deletions README-CH.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
[![Release](https://img.shields.io/github/v/release/thoughtworks/metrik.svg?include_prereleases&style=flat)](https://github.com/thoughtworks/metrik/releases)

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

<!-- PROJECT TITLE -->
<h1 align="center">
Expand Down Expand Up @@ -46,19 +46,23 @@
<!-- END OF PROJECT TITLE -->

<!-- ABOUT THE PROJECT -->

## 关于本项目

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

**关键差异化因素:**

* 单页配置,简单易用.
* 具有跨多个CD平台工作的能力.
* 用户可以自行选择要分析的环境(是的,生产环境不是唯一重要的环境)。

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


### 集成路线

产品现在支持/计划支持的CD工具清单

- [x] Jenkins
- [x] Bamboo
- [x] Github Actions
Expand All @@ -71,35 +75,43 @@


<!-- USAGE -->

## 用法

按照以下两个步骤来运行该工具,并测量你的项目的四个关键指标。

### 安装和运行

该产品被发布到ECR Docker仓库`public.ecr.aws/j2s5d3z8/4-key-metrics`。请按照以下步骤操作。
该产品被发布到Docker Hub仓库`docker.io/wszzwpshh1/metrik`。请按照以下步骤操作。

1. 确保[Docker](https://www.docker.com)已经安装在你的操作系统上。
2. 在发布页中查找可用的[已发布版本](https://github.com/thoughtworks/metrik/releases)
或者,你可以从我们的[镜像库]中找到所有的历史版本(https://gallery.ecr.aws/j2s5d3z8/4-key-metrics)
或者,你可以从我们的[镜像库]中找到所有的历史版本(https://hub.docker.com/r/wszzwpshh1/metrik)
3. 通过以下命令在本地运行该容器:

``` bash
docker run -d -p 80:80 --name metrik public.ecr.aws/j2s5d3z8/4-key-metrics:latest
docker run -d -p 80:80 --name metrik wszzwpshh1/metrik:latest
```
*⚠️ 我们使用80端口来访问该应用程序。如果80端口被你机器上运行的其他应用程序占用,你可以切换到任何其他端口。
*⚠️ `latest`标签匹配该仓库的最新版本。因此,使用 public.ecr.aws/j2s5d3z8/4-key-metrics:latest 或 public.ecr.aws/j2s5d3z8/4-key-metrics 将确保你运行的是这个镜像的最新版本*
如果你想使用一个特定的版本标签,请记住版本名称中没有 "v"。例如,public.ecr.aws/j2s5d3z8/4-key-metrics:1.1.10

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

### 配置

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

1. 开始配置:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step1.png" height=70% width=70%></div>

2. 随后每个关键指标的图表将出现在主页面上:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step2.png" height=70% width=70%></div>

3. 如果你想把它放在大屏幕上,还可以全屏观看:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step3.png" height=70% width=70%></div>

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

``` bash
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}
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}
```

<!-- END OF USAGE -->


<!-- HOW TO COMPUTE -->

## 算法
[详细算法请参考Wiki页面](https://github.com/thoughtworks/metrik/wiki)

[详细算法请参考Wiki页面](https://github.com/thoughtworks/metrik/wiki)
<!-- END OF HOW TO COMPUTE -->


<!-- CONTRIBUTING -->

## 贡献

贡献是使开源社区成为一个学习、激励和创造的神奇场所的原因。我们真诚的感谢你所做的任何类型的贡献.

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


<!-- GETTING STARTED -->

## 快速开始

该代码库由三个主要部分组成:"前端"、"后端 "和 "CI"。

* 前端应用由以下技术栈构建:
* TypeScript
* ReactJS
* ReCharts
* TypeScript
* ReactJS
* ReCharts

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

* 后端程序由以下技术栈构建:
* Kotlin
* Spring Boot Web
* MongoDB
* Kotlin
* Spring Boot Web
* MongoDB

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

* 构建/打包的脚本在[CI文件夹](https://github.com/thoughtworks/metrik/tree/main/ci)下。

<!-- END OF GETTING STARTED -->


<!-- MORE -->

## 更多

你可能会感兴趣的类似项目:

* [Buildvis](https://github.com/cburgmer/buildviz), transparency for your build pipeline's results and runtime
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD instance.
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision
control and project planning tools.
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD
instance.

<!-- END OF MORE -->


<!-- LICENSE -->

## License

在MIT许可下发布。更多信息见[LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt)
<!-- END OF LICENSE -->


<!-- CONTRIBUTORS -->

## Contributors ✨

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

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

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!
90 changes: 65 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,25 @@
<!-- END OF PROJECT TITLE -->

<!-- ABOUT THE PROJECT -->

## About the Project
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.

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.

**The key differentiators:**

* One page configuration, quick and easy.
* The ability to work across different CD platforms.
* User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the only one that matters)
* User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the
only one that matters)

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


### Integration roadmap

List of CD tools the product supports now/plan to support

- [x] Jenkins
- [x] Bamboo
- [x] GitHub Actions
Expand All @@ -67,99 +73,132 @@ List of CD tools the product supports now/plan to support


<!-- USAGE -->

## Usage

Follow the two steps below to run the tool, and measure the four key metrics of your projects.

### Install and run

The product is released to an ECR Docker repository `public.ecr.aws/j2s5d3z8/4-key-metrics`. Please follow the steps:
The product is released to a public repository hosted on Docker Hub `docker.io/wszzwpshh1/metrik`. Please follow the
steps:

1. Ensure [Docker](https://www.docker.com) has already installed on your OS.
2. Find available [release versions](https://github.com/thoughtworks/metrik/releases) in the release page.
Or, you can find all history versions from our [image repository](https://gallery.ecr.aws/j2s5d3z8/4-key-metrics)
Or, you can find all history versions from our [image repository](https://hub.docker.com/r/wszzwpshh1/metrik)
3. Run the container locally via the following command:

``` bash
docker run -d -p 80:80 --name metrik public.ecr.aws/j2s5d3z8/4-key-metrics:latest
docker run -d -p 80:80 --name metrik docker.io/wszzwpshh1/metrik:latest
```
*⚠️ 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.*
*⚠️ 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.*
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

*⚠️ 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.*
*⚠️ The `latest` tag matches the most recent version of this repository. Thus using wszzwpshh1/metrik:latest or
wszzwpshh1/metrik will ensure you are running the most up to date version of this image.*
If you want to stick to a specific version tag, remember there no "v" in version name. e.g. wszzwpshh1/metrik:latest:
1.6.5

### Configure your projects

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/`.
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/`.

1. Start the configuration:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step1.png" height=70% width=70%></div>

2. And the charts for each key metric will be available at the main page:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step2.png" height=70% width=70%></div>

3. Also the full screen view if you want to put it on big screens:

<div><img src="https://raw.githubusercontent.com/thoughtworks/metrik/main/.doc/img/step3.png" height=70% width=70%></div>

### Advanced usage

If you would like to keep the 4-key-metrics data to avoid losing any data when remove container, you
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:
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:

``` bash
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}
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}
```

<!-- END OF USAGE -->


<!-- Our Wiki -->

## How to Compute, FAQs
[See our Wiki page](https://github.com/thoughtworks/metrik/wiki)

[See our Wiki page](https://github.com/thoughtworks/metrik/wiki)
<!-- END OF HOW TO COMPUTE -->


<!-- CONTRIBUTING -->

## Contributing
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**.

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**.

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


<!-- GETTING STARTED -->

## Getting Started

The codebase comprises of three major components `frontend`, `backend`, `ci`.

* Frontend app is a web application built with:
* TypeScript
* ReactJS
* ReCharts
* TypeScript
* ReactJS
* ReCharts

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

* Backend app is built with:
* Kotlin
* Spring Boot Web
* MongoDB
* Kotlin
* Spring Boot Web
* MongoDB

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

* Build/Package scripts lives in [ci folder](https://github.com/thoughtworks/metrik/tree/main/ci)

<!-- END OF GETTING STARTED -->


<!-- MORE -->

## More

You might also like:

* [Buildvis](https://github.com/cburgmer/buildviz), transparency for your build pipeline's results and runtime
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD instance.
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision
control and project planning tools.
* [GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD
instance.

<!-- END OF MORE -->


<!-- LICENSE -->

## License
Distributed under the MIT License. See [LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt) for more information

Distributed under the MIT License. See [LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt) for more
information
<!-- END OF LICENSE -->


<!-- CONTRIBUTORS -->

## Contributors ✨

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

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

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

0 comments on commit e4974f6

Please sign in to comment.