Merge pull request #10793 from goharbor/fixing-links

Fixing lots of links

docs/1.10/_index.md

@@ -1,10 +1,8 @@
 ---
-title: Harbor Documentation
+title: Harbor 1.10 Documentation
 ---
 
-Welcome to the Harbor 1.10.x documentation. Use the table of contents on the left of the page to navigate through the docs.
-
-This documentation includes the following sections:
+Welcome to the Harbor 1.10.x documentation. This documentation includes all of the information that you need to install, configure, and use Harbor.
 
 ## Harbor Installation and Configuration
 

docs/1.10/administration/configuring-replication/_index.md

@@ -11,8 +11,4 @@ There might be some delay during replication based on the condition of the netwo
 
 {{< note >}}
 Due to API changes, replication between different versions of Harbor is not supported.
-{{< /note >}}
-
-- [Create Replication Endpoints](create-replication-endpoints.md)
-- [Create Replication Rules](create-replication-rules.md)
-- [Running Replication Manually](manage-replications.md)
+{{< /note >}}

docs/1.10/administration/configuring-replication/create-replication-endpoints.md

@@ -49,3 +49,7 @@ To replicate image repositories from one instance of Harbor to another Harbor or
 You can list, add, edit and delete registries under **Administration** -> **Registries**. Only registries which are not referenced by any rules can be deleted.  
 
 ![browse project](../../../img/manage-registry.png)
+
+## What to Do Next
+
+After you configure replication endpoints, see [Creating a Replication Rule](create-replication-rules.md).

docs/1.10/administration/configuring-replication/create-replication-rules.md

@@ -61,3 +61,7 @@ A replication endpoint must exist before you create a replication rule. To creat
 
 1. Optionally select the Override checkbox to force replicated resources to replace resources at the destination with the same name.
 1. Click **Save** to create the replication rule.  
+
+## What to Do Next
+
+After you create a replication rule, see [Running Replication Manually](manage-replications.md).

docs/1.10/administration/managing-users/_index.md

@@ -18,9 +18,9 @@ Besides the above roles, there are two system-level roles:
 * **Harbor system administrator**: "Harbor system administrator" has the most privileges. In addition to the privileges mentioned above, "Harbor system administrator" can also list all projects, set an ordinary user as administrator, delete users and set vulnerability scan policy for all images. The public project "library" is also owned by the administrator.
 * **Anonymous**: When a user is not logged in, the user is considered as an "Anonymous" user. An anonymous user has no access to private projects and has read-only access to public projects.
 
-For full details of the permissions of the different roles, see [User Permissions By Role](../user-permissions-by-role.md).
+For full details of the permissions of the different roles, see [User Permissions By Role](user-permissions-by-role.md).
 
-If you run Harbor in database authentication mode, you create user accounts directly in the Harbor interface. For information about how to create local user accounts, see [Create User Accounts in Database Mode](../create-users-db.md).
+If you run Harbor in database authentication mode, you create user accounts directly in the Harbor interface. For information about how to create local user accounts, see [Create User Accounts in Database Mode](create-users-db.md).
 
 If you run Harbor in LDAP/AD or OIDC authentication mode, you create and manage user accounts in your LDAP/AD or OIDC provider. Harbor obtains the users from the LDAP/AD or OIDC server and displays them in the **Users** tab of the Harbor interface.
 

docs/1.10/administration/managing-users/create-users-db.md

@@ -18,4 +18,4 @@ In database authentication mode, the Harbor system administrator creates user ac
     - The email address is used for password recovery
     - The password must contain at least 8 characters with 1 lowercase letter, 1 uppercase letter and 1 numeric character
 
-If users forget their password, there is a **Forgot Password** in the Harbor log in page. To use this feature, you must [configure an email server](../general-settings.md).
+If users forget their password, there is a **Forgot Password** in the Harbor log in page. To use this feature, you must [configure an email server](../general-settings/_index.md).

docs/1.10/administration/upgrade/_index.md

@@ -1,4 +1,70 @@
 ---
-title: Upgrade
+title: Upgrade Harbor and Migrate Data
 weight: 45
 ---
+
+This guide covers upgrade and migration to version 1.10.0. This guide only covers migration from v1.8.x and later to the current version. If you are upgrading from an earlier version, refer to the migration guide in the `release-1.8.0` branch to upgrade to v1.8.x first, then follow this guide to perform the migration to this version.
+
+If you are upgrading a Harbor instance that you deployed with Helm, see [Upgrading Harbor Deployed with Helm](helm-upgrade.md).
+
+When upgrading an existing Harbor instance to a newer version, you might need to migrate the data in your database and the settings in `harbor.cfg`.
+Since the migration might alter the database schema and the settings of `harbor.cfg`, you should **always** back up your data before any migration.
+
+## Notes
+
+- Again, you must back up your data before any data migration.
+- In version 1.9.0, some containers are started by `non-root`. This does not pose problems if you are upgrading an officially released version of Harbor, but if you have deployed a customized instance of Harbor, you might encounter permission issues.
+- In previous releases, user roles took precedence over group roles in a project. In this version, user roles and group roles are combined so that the user has whichever set of permissions is highest. This might cause the roles of certain users to change during upgrade.
+- With the introduction of storage and artifact quotas in version 1.9.0, migration from 1.8.x might take a few minutes. This is because the `core` walks through all blobs in the registry and populates the database with information about the layers and artifacts in projects.
+- With the introduction of storage and artifact quotas in version 1.9.0, replication between version 1.9.0 and a previous version of Harbor does not work. You must upgrade all Harbor nodes to 1.9.0 if you have configured replication between them.
+
+## Upgrading Harbor and Migrating Data
+
+1. Log in to the Harbor host and, if it is still running, stop and remove the existing Harbor instance.
+
+    ```sh
+    cd harbor
+    docker-compose down
+    ```
+
+1. Back up Harbor's current files so that you can roll back to the current version if necessary.
+
+    ```sh
+    mv harbor /my_backup_dir/harbor
+    ```
+
+1. Back up the database, which by default is in the directory `/data/database`.
+
+    ```sh
+    cp -r /data/database /my_backup_dir/
+    ```
+
+1. Get the latest Harbor release package from [https://github.com/goharbor/harbor/releases](https://github.com/goharbor/harbor/releases).
+1. Before upgrading Harbor, perform migration. 
+
+    The migration tool is delivered as a docker image. You can pull the image from docker hub. Replace [tag] with the new Harbor version, for example v1.10.0, in the following command:
+
+    ```sh
+    docker pull goharbor/harbor-migrator:[tag]
+    ```
+
+    Alternatively, if you are using an offline installer package, you can load it from the image tarball that is included in the offline installer package. Replace [tag] with the new Harbor version, for example v1.10.0, in the following command:
+
+    ```sh
+    tar zxf <offline package>
+    docker image load -i harbor/harbor.[version].tar.gz
+    ```
+
+1. Upgrade the `harbor.yml` file.
+
+    ```sh
+    docker run -it --rm -v ${harbor_yml}:/harbor-migration/harbor-cfg/harbor.yml goharbor/harbor-migrator:[tag] --cfg up
+    ```
+
+    **NOTE:** The schema upgrade and data migration of the database is performed by core when Harbor starts. If the migration fails, check the core log to debug.
+
+1. In the `./harbor` directory, run the `./install.sh` script to install the new Harbor instance. 
+
+   To install Harbor with components such as Notary, Clair, and chartmuseum, see [Run the Installer Script](../../install-config/run-installer-script.md) for more information.
+
+If you need to roll back to the previous version of Harbor, see [Roll Back from an Upgrade](roll-back-upgrade.md).

docs/1.10/administration/upgrade/roll-back-upgrade.md

@@ -6,7 +6,7 @@ weight: 45
 If, for any reason, you need to roll back to the previous version of Harbor, perform the following steps.
 
 {{< note >}}
-To roll back from an upgrade, you must have backed up the previous version of Harbor. For information about backing up Harbor before an upgrade, see [Upgrade Harbor and Migrate Data](../upgrade-migrate-data.md).
+To roll back from an upgrade, you must have backed up the previous version of Harbor. For information about backing up Harbor before an upgrade, see [Upgrade Harbor and Migrate Data](_index.md).
 {{< /note >}}
 
 1. Stop and remove the current Harbor service if it is still running.

docs/1.10/administration/vulnerability-scanning/_index.md

@@ -13,13 +13,6 @@ You can also connect Harbor to your own instance of Clair or to additional vulne
 
 It might be necessary to connect Harbor to other scanners for corporate compliance reasons, or because your organization already uses a particular scanner. Different scanners also use different vulnerability databases, capture different CVE sets, and apply different severity thresholds. By connecting Harbor to more than one vulnerability scanner, you broaden the scope of your protection against vulnerabilities.
 
-For information about installing Harbor with Clair, see the [Run the Installer Script](../../install-config/run-installer_script.md). 
+For information about installing Harbor with Clair, see the [Run the Installer Script](../../install-config/run-installer-script.md). 
 
 You can manually initiate scanning on a particular image, or on all images in Harbor. Additionally, you can also set a policy to automatically scan all of the images at specific intervals.
-
-- [Connect Harbor to Additional Vulnerability Scanners](../pluggable-scanners.md)
-- [Scan Individual Images](../scan-individual-image.md)
-- [Scan All Images](../scan-all-images.md)
-- [Schedule Scans](../schedule-scans.md)
-- [Import Vulnerability Data to an Offline Harbor instance](../import-vulnerability-data.md)
-- [Configure System-Wide CVE Whitelists](../configure-system-whitelist.md)

docs/1.10/administration/vulnerability-scanning/configure-system-whitelist.md

@@ -5,7 +5,7 @@ weight: 50
 
 When you run vulnerability scans, images that are subject to Common Vulnerabilities and Exposures (CVE) are identified. According to the severity of the CVE and your security settings, these images might not be permitted to run. As a Harbor system administrator, you can create whitelists of CVEs to ignore during vulnerability scanning. 
 
-You can set a system-wide CVE whitelist or you can set CVE whitelists on a per-project basis. For information about per-project CVE whitelists, see [Configure a Per-Project CVE Whitelist](../../working-with-projects/configure-project-whitelist.md).
+You can set a system-wide CVE whitelist or you can set CVE whitelists on a per-project basis. For information about per-project CVE whitelists, see [Configure a Per-Project CVE Whitelist](../../working-with-projects/project-configuration/configure-project-whitelist.md).
 
 System-wide CVE whitelists apply to all of the projects in a Harbor instance.
 

docs/1.10/administration/vulnerability-scanning/import-vulnerability-data.md

@@ -31,9 +31,9 @@ The phrase `finished fetching` indicates that Clair has finished a round of vuln
 1. Log in to the host, that is connected to Internet, on which the Postgres Clair database is running.
 1. Dump Clair's vulnerability database by running the following commands.
 
-    {{< note >}}
-    The container name `clair-db` is a placeholder for the database container used by the internet-connected instance of Clair.
-    {{< /note >}}
+   {{< note >}}
+   The container name `clair-db` is a placeholder for the database container used by the internet-connected instance of Clair.
+   {{< /note >}}
 
     ```shell
     $ docker exec clair-db /bin/sh -c  "pg_dump -U postgres -a -t feature -t keyvalue -t namespace -t schema_migrations -t vulnerability -t vulnerability_fixedin_feature" > vulnerability.sql  
@@ -62,4 +62,4 @@ docker exec harbor-db /bin/sh -c  "pg_dump -U postgres -c" > all.sql
 
 ## Rescan the Images
 
-After importing the data, trigger the scanning process in the Harbor interface. For information about running a scan, see [Scan All Images](../scan-all-images.md).
+After importing the data, trigger the scanning process in the Harbor interface. For information about running a scan, see [Scan All Images](scan-all-images.md).

docs/1.10/administration/vulnerability-scanning/pluggable-scanners.md

@@ -39,4 +39,4 @@ Depending on the scanner that you use, once the database is ready, the timestamp
 
 Until the database has been fully populated, the timestamp is replaced by a warning symbol. When the database is ready, you can scan images individually or scan all images across all projects.
 
-If your Harbor instance is not connected to the external internet, you must manually update the vulnerability metadata. For information about how to update Clair manually, see [Import Vulnerability Data to an Offline Harbor instance](../import-vulnerability-data.md).
+If your Harbor instance is not connected to the external internet, you must manually update the vulnerability metadata. For information about how to update Clair manually, see [Import Vulnerability Data to an Offline Harbor instance](import-vulnerability-data.md).

docs/1.10/administration/vulnerability-scanning/scan-individual-image.md

@@ -13,11 +13,11 @@ weight: 30
 
 1. Click **Edit** to select a different scanner from the list of scanners that are connected to this Harbor instance, and click **OK**.
 
-    ![Project scanner tab](../../../img/select-scanner.png)
+   ![Project scanner tab](../../../img/select-scanner.png)
 
-    {{< note >}}
-    If you have selected the **Prevent vulnerable images from running** option in the project **Configuration** tab, the prevention of pulling vulnerable images is determined by the scanner that is set in the project, or by the global default scanner if no scanner is configured specifically for the project. Different scanners might apply different levels of severity to image vulnerabilities.
-    {{< /note >}}
+   {{< note >}}
+   If you have selected the **Prevent vulnerable images from running** option in the project **Configuration** tab, the prevention of pulling vulnerable images is determined by the scanner that is set in the project, or by the global default scanner if no scanner is configured specifically for the project. Different scanners might apply different levels of severity to image vulnerabilities.
+   {{< /note >}}
 
 1. Select the **Repositories** tab and select a repository.
 

docs/1.10/build-customize-contribute/_index.md

@@ -2,3 +2,7 @@
 title: Building, Customizing, and Contributing to Harbor
 weight: 20
 ---
+
+This section describes how developers can build from Harbor source code, customize their deployments, and contribute to the open-source Harbor project.
+
+See also the list of [Articles from the Harbor Community](https://github.com/goharbor/harbor/blob/master/docs/README.md#articles-from-the-community).

docs/1.10/build-customize-contribute/compile-guide.md

@@ -29,7 +29,7 @@ git clone https://github.com/goharbor/harbor
 
 ### Configuration
 
-Edit the file **make/harbor.yml** and make necessary configuration changes such as hostname, admin password and mail server. Refer to the [Installation and Configuration Guide](../installation-guide.md#configuring-harbor) for more info.
+Edit the file **make/harbor.yml** and make necessary configuration changes such as hostname, admin password and mail server. Refer to [Harbor Installation and Configuration](../install-config/_index.md) for more info.
 
 ```sh
 cd harbor
@@ -99,7 +99,7 @@ If everything worked properly, you will see this message:
 Start complete. You can visit harbor now.
 ```
 
-Refer to the [Installation and Configuration Guide](../installation-guide.md#managing-harbors-lifecycle) for more information about managing your Harbor instance.
+Refer to [Reconfigure Harbor and Manage the Harbor Lifecycle](../install-config/reconfigure-manage-lifecycle.md) for more information about managing your Harbor instance.
 
 ## Appendix
 

docs/1.10/build-customize-contribute/developer-guide-i18n.md

@@ -70,4 +70,4 @@ Steps to localize the UI in your language
     </div>
     ```
 
-4. Next, please refer [compile guideline](../compile-guide.md) to rebuild and restart Harbor.
+4. Next, refer to [Build Harbor from Source Code](compile-guide.md) to rebuild and restart Harbor.