From 5f30b14332fb3f8746fc3bd8d630b812d5da0cd9 Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Fri, 1 Nov 2019 16:16:11 +0100 Subject: [PATCH] Adding contrib docs to index --- docs/harbor-doc-reorg/_index.md | 13 +++++++------ .../build_customize_contribute/compile_guide.md | 2 +- ...ze_look&feel_guide.md => customize_look_feel.md} | 0 .../developer_guide_i18n.md | 2 +- .../ui_contribution_get_started.md | 2 +- .../build_customize_contribute/use_make.md | 2 +- 6 files changed, 11 insertions(+), 10 deletions(-) rename docs/harbor-doc-reorg/build_customize_contribute/{customize_look&feel_guide.md => customize_look_feel.md} (100%) diff --git a/docs/harbor-doc-reorg/_index.md b/docs/harbor-doc-reorg/_index.md index d1a47ba89..7da5650e1 100644 --- a/docs/harbor-doc-reorg/_index.md +++ b/docs/harbor-doc-reorg/_index.md @@ -72,9 +72,10 @@ This section describes how users with the developer, master, and project adminis This section describes how developers can build from Harbor source code, customize their deployments, and contribute to the open-source Harbor project. -- [](build_customize_contribute/) -- [](build_customize_contribute/) -- [](build_customize_contribute/) -- [](build_customize_contribute/) -- [](build_customize_contribute/) -- [](build_customize_contribute/) \ No newline at end of file +- [Build Harbor from Source Code](build_customize_contribute/compile_guide.md) +- [Developing the Harbor Frontend](build_customize_contribute/ui_contribution_get_started.md) +- [Customize the Harbor Look & Feel ](build_customize_contribute/customize_look_feel.md) +- [Developing for Internationalization](build_customize_contribute/developer_guide_i18n.md) +- [Using Make](build_customize_contribute/use_make.md) +- [View and test Harbor REST API via Swagger](build_customize_contribute/configure_swagger.md) +- [Registry Landscape](build_customize_contribute/registry_landscape.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/build_customize_contribute/compile_guide.md b/docs/harbor-doc-reorg/build_customize_contribute/compile_guide.md index 1d28daea5..6026249c7 100644 --- a/docs/harbor-doc-reorg/build_customize_contribute/compile_guide.md +++ b/docs/harbor-doc-reorg/build_customize_contribute/compile_guide.md @@ -1,4 +1,4 @@ -## Introduction +# Build Harbor from Source Code This guide provides instructions for developers to build and run Harbor from source code. diff --git a/docs/harbor-doc-reorg/build_customize_contribute/customize_look&feel_guide.md b/docs/harbor-doc-reorg/build_customize_contribute/customize_look_feel.md similarity index 100% rename from docs/harbor-doc-reorg/build_customize_contribute/customize_look&feel_guide.md rename to docs/harbor-doc-reorg/build_customize_contribute/customize_look_feel.md diff --git a/docs/harbor-doc-reorg/build_customize_contribute/developer_guide_i18n.md b/docs/harbor-doc-reorg/build_customize_contribute/developer_guide_i18n.md index 96fb8744c..625682b1a 100644 --- a/docs/harbor-doc-reorg/build_customize_contribute/developer_guide_i18n.md +++ b/docs/harbor-doc-reorg/build_customize_contribute/developer_guide_i18n.md @@ -1,4 +1,4 @@ -## Developer's Guide for Internationalization (i18n) +## Developing for Internationalization *NOTE: All the files you created should use UTF-8 encoding.* diff --git a/docs/harbor-doc-reorg/build_customize_contribute/ui_contribution_get_started.md b/docs/harbor-doc-reorg/build_customize_contribute/ui_contribution_get_started.md index 99511afdf..accbebc29 100644 --- a/docs/harbor-doc-reorg/build_customize_contribute/ui_contribution_get_started.md +++ b/docs/harbor-doc-reorg/build_customize_contribute/ui_contribution_get_started.md @@ -1,4 +1,4 @@ -# Harbor frontend environment get started guide +# Developing the Harbor Frontend If you already have a harbor backend environment, you can build a frontend development environment with the following configuration. diff --git a/docs/harbor-doc-reorg/build_customize_contribute/use_make.md b/docs/harbor-doc-reorg/build_customize_contribute/use_make.md index 2d56f6eaa..7c60ee86d 100644 --- a/docs/harbor-doc-reorg/build_customize_contribute/use_make.md +++ b/docs/harbor-doc-reorg/build_customize_contribute/use_make.md @@ -1,4 +1,4 @@ -### Variables +# Using Make Variable | Description -------------------|------------- BASEIMAGE | Container base image, default: photon