From 2fc07a04c6da05bc8eafa2fb2e9e6c0b38d6c7ae Mon Sep 17 00:00:00 2001 From: Henry Zhang Date: Tue, 13 Sep 2016 18:21:21 +0800 Subject: [PATCH] README --- README.md | 3 +-- docs/README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 2 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 67d94dfc1..e17b4d9cc 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ Project Harbor is an enterprise-class registry server that stores and distribute * **Graphical user portal**: User can easily browse, search repositories and manage projects. * **AD/LDAP support**: Harbor integrates with existing enterprise AD/LDAP for user authentication and management. * **Auditing**: All the operations to the repositories are tracked. -* **Internationalization**: Already localized for English, Chinese, German, Japanese and Russian. More languages can be added. * **RESTful API**: RESTful APIs for most administrative operations, easy to integrate with external systems. * **Easy deployment**: docker compose and offline installer. @@ -91,4 +90,4 @@ This project uses open source components which have additional licensing terms. beego Harbor is powered by Beego. ### About -Project Harbor is initiated by the Advanced Technology Center (ATC), VMware China R&D as a Cloud Application Accelerator (CAA) project. +Project Harbor is initiated by the Advanced Technology Center (ATC), VMware China R&D. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..0f0105dbd --- /dev/null +++ b/docs/README.md @@ -0,0 +1,33 @@ +## Table of Content +### User document +[Installation and Configuration Guide](installation_guide.md) +Read this first! + +[Harbor User Guide](user_guide.md) +How to use Harbor to manage images, projects, replications and users. + +[Configuring HTTPS for Harbor](configure_https.md) +Configure security connection between Harbor and Docker client. + +[Upgrade and Data Migration Guide](migration_guide.md) +Data migration may be needed when upgrading Harbor to a newer version. + +[Deploy Harbor on Kubernetes](kubernetes_deployment.md) +Guide to deploy Harbor on Kubenetes. (maintained by community) + +### Developer document +[Arthicture Overview of Harbor](https://github.com/vmware/harbor/wiki/Architecture-Overview-of-Harbor) +Developers read this first. + +[Harbor API Specs by Swagger](configure_swagger.md) +Use Swagger to find out the specs of Harbor API. + +[Internationalization Guide](developer_guide_i18n.md) +How to add your local language to Harbor. + +[Python SDK](../contrib/sdk/harbor-py) (by community) + +[Deploying Harbor using Docker Machine](../contrib/deploying_using_docker_machine.md) ( by community) + +[Configuring Harbor as a local registry mirror](../contrib/Configure_mirror.md) (by community) +