From 52cae5581304ba152840e76f30d2fdf5df842025 Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Tue, 17 Dec 2019 13:54:38 +0100 Subject: [PATCH] Smallificated TOC link --- docs/harbor-doc-reorg/install_config/_index.md | 4 +++- docs/harbor-doc-reorg/install_config/installation/_index.md | 4 +++- .../install_config/installation/configure_https.md | 4 +++- .../install_config/installation/configure_yml_file.md | 5 +++-- .../install_config/installation/demo_server.md | 2 ++ .../install_config/installation/download_installer.md | 4 +++- .../install_config/installation/harbor_compatibility_list.md | 4 +++- .../install_config/installation/installation_prereqs.md | 4 +++- .../install_config/installation/run_installer_script.md | 4 +++- .../install_config/installation/troubleshoot_installation.md | 4 +++- 10 files changed, 29 insertions(+), 10 deletions(-) diff --git a/docs/harbor-doc-reorg/install_config/_index.md b/docs/harbor-doc-reorg/install_config/_index.md index 16ca0f653..0b49d19f8 100644 --- a/docs/harbor-doc-reorg/install_config/_index.md +++ b/docs/harbor-doc-reorg/install_config/_index.md @@ -1,3 +1,5 @@ +Back to table of contents + # Harbor Installation and Configuration This document describes how to install Harbor, and how to perform initial configuration. @@ -6,4 +8,4 @@ This document describes how to install Harbor, and how to perform initial config - [Post-Installation Configuration](configuration/_index.md) - [Initial Configuration in the Harbor UI](configuration/initial_config_ui.md) -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/_index.md b/docs/harbor-doc-reorg/install_config/installation/_index.md index e2e6f8432..43f6d05da 100644 --- a/docs/harbor-doc-reorg/install_config/installation/_index.md +++ b/docs/harbor-doc-reorg/install_config/installation/_index.md @@ -1,3 +1,5 @@ +Back to table of contents + # Installing Harbor This guide describes how to install for the first time. @@ -35,4 +37,4 @@ The table below lists the components that are deployed when you deploy Harbor. |Helm|2.9.1| |Swagger-ui|3.22.1| -[Back to table of contents](../index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/configure_https.md b/docs/harbor-doc-reorg/install_config/installation/configure_https.md index 3aca57fdd..53d4faa79 100644 --- a/docs/harbor-doc-reorg/install_config/installation/configure_https.md +++ b/docs/harbor-doc-reorg/install_config/installation/configure_https.md @@ -1,3 +1,5 @@ +Back to table of contents + # Configure HTTPS Access to Harbor By default, Harbor does not ship with certificates. It is possible to deploy Harbor without security, so that you can connect to it over HTTP. However, using HTTP is acceptable only in air-gapped test or development environments that do not have a connection to the external internet. Using HTTP in environments that are not air-gapped exposes you to man-in-the-middle attacks. In production environments, always use HTTPS. If you enable Content Trust with Notary to properly sign all images, you must use HTTPS. @@ -197,4 +199,4 @@ If you've mapped nginx 443 port to another, you need to add the port to login, l To start the installation process, [Download the Harbor Installer](download_installer.md). -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md b/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md index 9853f5ca8..f5e4006e8 100644 --- a/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md +++ b/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md @@ -1,4 +1,5 @@ -[Back to table of contents](../../_index.md) +Back to table of contents + # Configure the Harbor YML File You set system level parameters for Harbor in the `harbor.yml` file that is contained in the installer package. These parameters take effect when you run the `install.sh` script to install or reconfigure Harbor. @@ -333,4 +334,4 @@ Currently, Harbor only supports PostgreSQL database. To use an external database To install Harbor, [Run the Installer Script](run_installer_script.md). -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/demo_server.md b/docs/harbor-doc-reorg/install_config/installation/demo_server.md index 91205cd00..d0544eb77 100644 --- a/docs/harbor-doc-reorg/install_config/installation/demo_server.md +++ b/docs/harbor-doc-reorg/install_config/installation/demo_server.md @@ -1,3 +1,5 @@ +Back to table of contents + # Test Harbor with the Demo Server The Harbor team has made available a demo Harbor instance that you can use to experiment with Harbor and test its functionalities. diff --git a/docs/harbor-doc-reorg/install_config/installation/download_installer.md b/docs/harbor-doc-reorg/install_config/installation/download_installer.md index d54529635..2a7496114 100644 --- a/docs/harbor-doc-reorg/install_config/installation/download_installer.md +++ b/docs/harbor-doc-reorg/install_config/installation/download_installer.md @@ -1,3 +1,5 @@ +Back to table of contents + # Download the Harbor Installer: You download the installers from the **[official releases](https://github.com/goharbor/harbor/releases)** page. Choose either the online or the offline installer. @@ -45,4 +47,4 @@ The installation processes are almost the same for both the online and offline i To prepare your Harbor installation, [Configure the Harbor YML File](configure_yml_file.md). -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/harbor_compatibility_list.md b/docs/harbor-doc-reorg/install_config/installation/harbor_compatibility_list.md index c795ebbf9..cd8df8e8c 100644 --- a/docs/harbor-doc-reorg/install_config/installation/harbor_compatibility_list.md +++ b/docs/harbor-doc-reorg/install_config/installation/harbor_compatibility_list.md @@ -1,3 +1,5 @@ +Back to table of contents + # Harbor Compatibility List This document provides compatibility information for all Harbor components. @@ -49,4 +51,4 @@ This document provides compatibility information for all Harbor components. * `Evaluated` means that the scanner implementation has been officially tested and verified. * `As Default` means that the scanner is provided as a default option and can be deployed together with the main Harbor components by providing extra options during installation. You must install other scanners manually. -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md b/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md index 4221a1f8c..f565199b3 100644 --- a/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md +++ b/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md @@ -1,3 +1,5 @@ +Back to table of contents + # Harbor Installation Prerequisites Harbor is deployed as several Docker containers. You can therefore deploy it on any Linux distribution that supports Docker. The target host requires Docker, and Docker Compose to be installed. @@ -36,4 +38,4 @@ Harbor requires that the following ports be open on the target host. To secure the connections the Harbor, you must [Configure HTTPS Access to Harbor](configure_https.md). -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md b/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md index 60c9fbf70..a4f6ecffd 100644 --- a/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md +++ b/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md @@ -1,3 +1,5 @@ +Back to table of contents + # Run the Installer Script Once you have configured **harbor.yml** and optionally set up a storage backend, you install and start Harbor by using the `install.sh` script. Note that it might take some time for the online installer to download all of the Harbor images from Docker hub. @@ -101,4 +103,4 @@ If the installation succeeds, continue to set up Harbor by following the instruc If installation fails, see [Troubleshooting Harbor Installation ](troubleshoot_installation.md). -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md b/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md index b9302d54a..e5effd4a5 100644 --- a/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md +++ b/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md @@ -1,3 +1,5 @@ +Back to table of contents + # Troubleshooting Harbor Installation ## Harbor Doesn't Start or Functions Incorrectly @@ -32,4 +34,4 @@ proxy_set_header X-Forwarded-Proto $scheme; Then re-deploy Harbor per the instructions in "Managing Harbor Lifecycle. -[Back to table of contents](../../_index.md) \ No newline at end of file +Back to table of contents \ No newline at end of file