From 0cf37932970f4001dc2700f39f5257efa2c70294 Mon Sep 17 00:00:00 2001 From: Steven Zou Date: Thu, 12 Dec 2019 18:43:49 +0800 Subject: [PATCH] doc[compatibility]:add doc ref in the README - refer the harbor compatibility doc in the README - add .md suffix to the README file under api/harbor Signed-off-by: Steven Zou --- README.md | 8 ++++++++ api/harbor/{README => README.md} | 0 2 files changed, 8 insertions(+) rename api/harbor/{README => README.md} (100%) diff --git a/README.md b/README.md index 83a1f5378..870921753 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,14 @@ Harbor is hosted by the [Cloud Native Computing Foundation](https://cncf.io) (CN * [Harbor RESTful API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/goharbor/harbor/master/api/harbor/swagger.yaml): The APIs for most administrative operations of Harbor and can be used to perform integrations with Harbor programmatically. - Spec validation status: +## Compatibility + +The [compatibility list](./docs/harbor_compatibility_list.md) document provides compatibility information for the Harbor components. + +- [Replication adapters](./docs/harbor_compatibility_list.md#Replication-Adapters) +- [OIDC adapters](./docs/harbor_compatibility_list.md#OIDC-Adapters) +- [Scanner adapters](./docs/harbor_compatibility_list.md#Scanner-Adapters) + ## Install & Run **System requirements:** diff --git a/api/harbor/README b/api/harbor/README.md similarity index 100% rename from api/harbor/README rename to api/harbor/README.md