From f6d099e8a1e7f7603ebdba0d703baf68295ebbd2 Mon Sep 17 00:00:00 2001 From: Han Xiao Date: Mon, 21 Oct 2019 11:35:03 +0800 Subject: [PATCH] docs(readme): fix typo --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4bf2cfa0..6e16fae4 100644 --- a/README.md +++ b/README.md @@ -145,12 +145,11 @@ Besides the `alpine` image optimized for the space, we also provide Buster (Debi -We also provide a public mirror hosted on Tencent Cloud and [Github packages](https://github.com/gnes-ai/gnes/packages/). Select the mirror that serves you well. +> ⚠️ Since 2019/10/21, we have stopped hosting the public mirror Tencent Cloud. The old Docker images still exist, but there won't be new images available on Tencent Cloud anymore. + +We also provide a public mirror [Github packages](https://github.com/gnes-ai/gnes/packages/). Select the mirror that serves you well. ```bash -docker login --username=xxx ccr.ccs.tencentyun.com # login to Tencent Cloud so that we can pull from it -docker run ccr.ccs.tencentyun.com/gnes/gnes:latest-alpine -# OR via Github package docker login --username=xxx docker.pkg.github.com/gnes-ai/gnes # login to github package so that we can pull from it docker run docker.pkg.github.com/gnes-ai/gnes/gnes:latest-alpine ``` @@ -167,10 +166,6 @@ The table below shows the status of the build pipeline. Github Package
docker.pkg.github.com/gnes-ai/gnes/gnes:[tag] - -Tencent Cloud
ccr.ccs.tencentyun.com/gnes/gnes:[tag] - - ### Install GNES via `pip` @@ -226,9 +221,9 @@ Either way, if you end up reading the following message after `$ gnes` or `$ doc - [🐣 Preliminaries](#-preliminaries) * [Microservice](#microservice) - * [Runtime](#runtime) + * [Workflow](#workflow) - [Building a flower search engine in 3 minutes](#building-a-flower-search-engine-in-3-minutes) - * [Define the indexing workflow:](#define-the-indexing-workflow-) + * [Define the indexing workflow](#define-the-indexing-workflow) * [Indexing flower image data](#indexing-flower-image-data) * [Querying similar flowers](#querying-similar-flowers) - [Elastic made easy](#elastic-made-easy) @@ -239,7 +234,7 @@ Either way, if you end up reading the following message after `$ gnes` or `$ doc ### 🐣 Preliminaries -Before we start, let me first introduce two important concepts serving as the backbone of GNES: **microservice** and **workflow**. +Before we start, let me first introduce two important concepts in GNES: **microservice** and **workflow**. #### Microservice @@ -268,7 +263,7 @@ These three tasks correspond to three different **workflows** in GNES. In this example, we will use the new `gnes.flow` API (`gnes >= 0.0.46` is required) to build a toy image search system for indexing and retrieving [flowers](http://www.robots.ox.ac.uk/~vgg/data/flowers/17/) based on their similarities. -#### Define the indexing workflow: +#### Define the indexing workflow Let's first define the indexing workflow by: @@ -471,7 +466,7 @@ We have setup [this repository](https://github.com/gnes-ai/benchmark) to track t 1. Create a new branch, say `fix-gnes-typo-1` 2. Fix/improve the codebase 3. Commit the changes. Note the **commit message must follow [the naming style]((#commit-message-naming))**, say `fix(readme): improve the readability and move sections` -4. Make a pull request. Note the **commit message must follow [the naming style]((#commit-message-naming))**. It can simply be one of your commit messages, just copy paste it, e.g. `fix(readme): improve the readability and move sections` +4. Make a pull request. Note the **pull request must follow [the naming style]((#commit-message-naming))**. It can simply be one of your commit messages, just copy paste it, e.g. `fix(readme): improve the readability and move sections` 5. Submit your pull request and wait for all checks passed (usually 10 minutes) - Coding style - Commit and PR styles check