From 47effb053373bee0a367bdb2f39ded18f8c1d8d4 Mon Sep 17 00:00:00 2001 From: Simon Alling Date: Thu, 10 Mar 2022 06:12:55 +0100 Subject: [PATCH] docs: Link to latest/edge docs instead of 2.0.0 (#14945) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I cloned the repo, clicked a link to the build guideline in `CONTRIBUTING.md` and copied the "Build, install and bring up Harbor without Notary" command: make install GOBUILDIMAGE=golang:1.12.5 COMPILETAG=compile_golangimage Being unfamiliar with the Harbor project, I didn't realize that said command was for building version 2.0.0 and that I had cloned a newer, incompatible version (2.3.0), so I just ran it and was met by errors: […] # github.com/goharbor/harbor/src/lib/errors ../lib/errors/errors.go:26:7: undefined: errors.As ../lib/errors/errors.go:28:7: undefined: errors.Is note: module requires Go 1.15 # github.com/hashicorp/go-multierror […] make: *** [Makefile:369: compile_core] Error 2 It took me a while to figure out what the problem was; then I replaced `2.0.0` with `latest` in the URL and found this command instead: make install GOBUILDIMAGE=golang:1.13.8 COMPILETAG=compile_golangimage _Et voilà_ – it worked! I figured `latest` (which currently redirects to 2.2.0) would make the most sense for end users and `edge` (which doesn't redirect) for contributors. Signed-off-by: Simon Alling --- CONTRIBUTING.md | 6 +++--- README.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 147e20782..607fe5cd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ git fetch $USER ``` **NOTES:** Note that GOPATH can be any directory, the example above uses $HOME/go. Change $USER above to your own GitHub username. -To build the project, please refer the [build](https://goharbor.io/docs/2.0.0/build-customize-contribute/compile-guide/) guideline. +To build the project, please refer the [build](https://goharbor.io/docs/edge/build-customize-contribute/compile-guide/) guideline. ### Repository Structure @@ -192,7 +192,7 @@ Harbor web UI is built based on [Clarity](https://vmware.github.io/clarity/) and To run the Web UI code, please refer to the UI [start](https://github.com/goharbor/harbor/blob/master/src/portal/README.md) guideline. -To run the code, please refer to the [build](https://goharbor.io/docs/2.0.0/build-customize-contribute/compile-guide/) guideline. +To run the code, please refer to the [build](https://goharbor.io/docs/edge/build-customize-contribute/compile-guide/) guideline. ## Contribute Workflow @@ -270,7 +270,7 @@ Run UI library test cases: npm run test ``` -To build the code, please refer to [build](https://goharbor.io/docs/2.0.0/build-customize-contribute/compile-guide/) guideline. +To build the code, please refer to [build](https://goharbor.io/docs/edge/build-customize-contribute/compile-guide/) guideline. **Note**: from v2.0, Harbor uses [go-swagger](https://github.com/go-swagger/go-swagger) to generate API server from Swagger 2.0 (aka [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)). To add or change the APIs, first update the `api/v2.0/swagger.yaml` file, then run `make gen_apis` to generate the API server, finally, implement or update the API handlers in `src/server/v2.0/handler` package. diff --git a/README.md b/README.md index 5bf1f66aa..24152d6fd 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ For learning the architecture design of Harbor, check the document [Architecture **On a Linux host:** docker 17.06.0-ce+ and docker-compose 1.18.0+ . -Download binaries of **[Harbor release ](https://github.com/vmware/harbor/releases)** and follow **[Installation & Configuration Guide](https://goharbor.io/docs/2.0.0/install-config/)** to install Harbor. +Download binaries of **[Harbor release ](https://github.com/vmware/harbor/releases)** and follow **[Installation & Configuration Guide](https://goharbor.io/docs/latest/install-config/)** to install Harbor. If you want to deploy Harbor on Kubernetes, please use the **[Harbor chart](https://github.com/goharbor/harbor-helm)**. @@ -84,7 +84,7 @@ The [compatibility list](https://goharbor.io/docs/edge/install-config/harbor-com ## Demos -* **[Live Demo](https://demo.goharbor.io)** - A demo environment with the latest Harbor stable build installed. For additional information please refer to [this page](https://goharbor.io/docs/2.0.0/install-config/demo-server/). +* **[Live Demo](https://demo.goharbor.io)** - A demo environment with the latest Harbor stable build installed. For additional information please refer to [this page](https://goharbor.io/docs/latest/install-config/demo-server/). * **[Video Demos](https://github.com/goharbor/harbor/wiki/Video-demos-for-Harbor)** - Demos for Harbor features and continuously updated. ## Partners and Users