[HWORKS-899] FIX: links and adding CI check for broken links (#339)

Author: Jacarte

.github/workflows/mkdocs-test.yml

@@ -20,12 +20,26 @@ jobs:
         run: sudo apt-get install -y libxml2-dev libxslt-dev
 
       - name: install deps
-        run: pip3 install pip==22.0.3 && pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python' mkdocs-minify-plugin
+        run: pip3 install pip==22.0.3 && pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python' mkdocs-minify-plugin linkchecker
 
       - name: setup git
         run: |
           git config --global user.name Mike
           git config --global user.email mike@docs.hopsworks.ai
 
+      - name: test broken links
+        run: |
+          # run the server
+          mkdocs serve  > /dev/null 2>&1 &
+          SERVER_PID=$!
+          echo "mk server in PID $SERVER_PID"
+          # Give enough time for deployment
+          sleep 30
+          echo "Launching linkchecker"
+          linkchecker --no-warnings --no-status http://127.0.0.1:8000/
+
+          # If ok just kill the server
+          kill -9 $SERVER_PID
+
       - name: mike deploy docs
         run: mike deploy 3.2-SNAPSHOT dev -u

README.md

@@ -47,4 +47,20 @@ The documentation should now be available locally on the following URL: http://1
 ## Adding new pages
 
 The `mkdocs.yml` file of this repository defines the pages to show in the navigation. 
-After adding your new page in the docs folder, you also need to add it to this file for it to show up in the navigation.
+After adding your new page in the docs folder, you also need to add it to this file for it to show up in the navigation.
+
+## Checking links
+
+``` bash
+# run the server
+mkdocs serve  > /dev/null 2>&1 &
+SERVER_PID=$!
+echo "mk server in PID $SERVER_PID"
+# Give enough time for serving
+sleep 30
+echo "Launching linkchecker"
+linkchecker http://127.0.0.1:8000/
+
+# If ok just kill the server
+kill -9 $SERVER_PID
+```

docs/admin/alert.md

@@ -34,7 +34,7 @@ button on the left side of the **email** row and fill out the form that pops up.
   CRAM-MD5, LOGIN or PLAIN.
 
 Optionally cluster wide Email alert receivers can be added in _Default receiver emails_.
-These receivers will be available to all users when they create event triggered [alerts](../../user_guides/projects/jobs/alert).
+These receivers will be available to all users when they create event triggered [alerts](../../user_guides/fs/feature_group/advanced_data_validation/#setup-alerts).
 
 ### Step 3: Configure Slack Alerts
 Alerts can also be sent via Slack messages. To be able to send Slack messages you first need to configure
@@ -47,7 +47,7 @@ a Slack webhook. Click on the _Configure_ button on the left side of the **slack
 </figure>
 
 Optionally cluster wide Slack alert receivers can be added in _Slack channel/user_.
-These receivers will be available to all users when they create event triggered [alerts](../../user_guides/projects/jobs/alert).
+These receivers will be available to all users when they create event triggered [alerts](../../user_guides/fs/feature_group/advanced_data_validation/#setup-alerts).
 
 ### Step 4: Configure Pagerduty Alerts
 Pagerduty is another way you can send alerts from Hopsworks. Click on the _Configure_ button on the left side of 
@@ -93,7 +93,7 @@ global:
  ...
 ```
 
-To test the alerts by creating triggers from Jobs and Feature group validations see [Alerts](../../user_guides/projects/jobs/alert).
+To test the alerts by creating triggers from Jobs and Feature group validations see [Alerts](../../user_guides/fs/feature_group/advanced_data_validation/#setup-alerts).
 
 The yaml syntax in the UI is slightly different in that it does not allow double quotes (it will ignore the values but give no error). 
 Below is an example configuration, that can be used in the UI, with both email and slack receivers configured for system alerts.

docs/assets/images/guides/integrations/parameter-store.png

@@ -149,7 +149,7 @@ Refer to [Create a VPC](restrictive_permissions.md#step-1-create-a-vpc) for more
 </p>
 
 !!! note
-    If the VPC uses a custom domain read our [guide](custom_domain_name.md) on how to set this up
+    If the VPC uses a custom domain read our [guide](./custom_domain_name.md) on how to set this up
 
 ### Step 9 Availability Zone selection
 If you selected an existing VPC in the previous step, this step lets you select which availability zone of this VPC to use.

docs/assets/images/hopsworks-version.png

@@ -51,7 +51,7 @@ in a configured Route 53 hosted zone.
 
 !!! warning
     If you want the VM to register itself with Route 53 you **must** amend the
-    [Instance Profile](cluster_creation/#step-5-select-the-instance-profile) with the following permissions
+    [Instance Profile](../cluster_creation) with the following permissions
 
 ```json
 {

docs/setup_installation/aws/cluster_creation.md

@@ -41,6 +41,6 @@ If you encounter the following error right after creating your cluster, then the
 
 This issue could be caused by one of the following:
 
-* The [instance profile that you have chosen during cluster creation](cluster_creation/#step-5-select-the-instance-profile) is actually missing the permissions stated in the error  on your [chosen S3 bucket](cluster_creation/#step-2-setting-the-general-information). Then in that case, update your instance profile accordingly and then click *Retry* to retry cluster creation operation. 
+* The [instance profile that you have chosen during cluster creation](../cluster_creation/#step-5-select-the-instance-profile) is actually missing the permissions stated in the error  on your [chosen S3 bucket](../cluster_creation/#step-2-setting-the-general-information). Then in that case, update your instance profile accordingly and then click *Retry* to retry cluster creation operation. 
 
 * Your AWS organization is using [SCPs policy](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html) that disallow policy simulation. In that case, you could do a simple test to confirm the issue by using [the AWS PolicySim on AWS console](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html). If policy simulation is disallowed, you can configure managed.hopsworks.ai to skip the policy simulation step by removing the `iam:SimulatePrincipalPolicy` permission from [your cross account role](../getting_started/#step-1-connecting-your-aws-account), by navigating to the [AWS Roles console](https://us-east-1.console.aws.amazon.com/iamv2/home#/roles), search for your cross account role name and click on it, on the permissions tab click edit on hopsworks inline policy, choose JSON tab, remove `iam:SimulatePrincipalPolicy`, click *Review Policy*, and then click *Save Changes*, and finally navigate back to managed.hopsworks.ai and click *Retry* to retry the cluster creation.

docs/setup_installation/aws/custom_domain_name.md

@@ -34,7 +34,7 @@ Then click on the secret in the secrets list and take note of the *Secret ARN*.
 
 <p align="center">
   <figure>
-    <img src="../../../../assets/images/guides/integrations/images/emr/secrets_manager.png" alt="Name the secret">
+    <img src="../../../../assets/images/guides/integrations/emr/secrets_manager.png" alt="Name the secret">
     <figcaption>Name the secret</figcaption>
   </figure>
 </p>
@@ -173,7 +173,7 @@ sudo pip3 install --upgrade hsfs~=X.X.0
 
 <p align="center">
     <figure>
-      <img src="../../../../assets/images/guides/integrations/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
+      <img src="../../../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
       <figcaption>To find your Hopsworks version, enter any of your projects and go to the settings tab inside your project.</figcaption>
     </figure>
 </p>

docs/setup_installation/aws/troubleshooting.md

@@ -31,7 +31,7 @@ The script action needs to be applied head and worker nodes and can be applied d
 
     <p align="center">
         <figure>
-            <img src="../../../assets/images/guides/integrations/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
+            <img src="../../../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
             <figcaption>You find the Hopsworks version inside any of your Project's settings tab on Hopsworks</figcaption>
         </figure>
     </p>

docs/user_guides/integrations/emr/emr_configuration.md

@@ -21,7 +21,7 @@ To connect to the Feature Store from the Azure Machine Learning Designer, create
 
 <p align="center">
   <figure>
-    <img src="../../../assets/images/guides/integrations/azure/designer/step-1.png" alt="Add an Execute Python Script step">
+    <img src="../../../../assets/images/guides/integrations/azure/designer/step-1.png" alt="Add an Execute Python Script step">
     <figcaption>Add an Execute Python Script step</figcaption>
   </figure>
 </p>
@@ -41,7 +41,7 @@ In the pipeline, add a new `Execute Python Script` step and replace the Python s
 
     <p align="center">
     <figure>
-        <img src="../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
+        <img src="../../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
         <figcaption>You find the Hopsworks version inside any of your Project's settings tab on Hopsworks</figcaption>
     </figure>
     </p>

docs/user_guides/integrations/hdinsight.md

@@ -21,7 +21,7 @@ To access the Feature Store from Azure Machine Learning, open a Python notebook
 
 <p align="center">
   <figure>
-    <img src="../../../assets/images/guides/integrations/azure/notebooks/step-1.png" alt="Connecting from an Azure Machine Learning Notebook">
+    <img src="../../../../assets/images/guides/integrations/azure/notebooks/step-1.png" alt="Connecting from an Azure Machine Learning Notebook">
     <figcaption>Connecting from an Azure Machine Learning Notebook</figcaption>
   </figure>
 </p>
@@ -43,7 +43,7 @@ To be able to access the Hopsworks Feature Store, the `HSFS` Python library need
 
     <p align="center">
         <figure>
-            <img src="../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
+            <img src="../../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
             <figcaption>You find the Hopsworks version inside any of your Project's settings tab on Hopsworks</figcaption>
         </figure>
     </p>

docs/user_guides/integrations/mlstudio_designer.md

@@ -20,7 +20,7 @@ The **major version of `HSFS`** needs to match the **major version of Hopsworks*
 
 <p align="center">
     <figure>
-        <img src="../../../../assets/images/guides/integrations/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
+        <img src="../../../../assets/images/hopsworks-version.png" alt="HSFS version needs to match the major version of Hopsworks">
         <figcaption>You find the Hopsworks version inside any of your Project's settings tab on Hopsworks</figcaption>
     </figure>
 </p>

docs/user_guides/integrations/mlstudio_notebooks.md

@@ -188,6 +188,7 @@ nav:
           - Cluster Creation: setup_installation/aws/cluster_creation.md
           - EKS integration: setup_installation/aws/eks_ecr_integration.md
           - Limiting Permissions: setup_installation/aws/restrictive_permissions.md
+          - Custom Domain: setup_installation/aws/custom_domain_name.md
           - Cluster upgrade:
               - Version 3.0 or newer: setup_installation/aws/upgrade_3.0.md
               - Version 2.4 or newer: setup_installation/aws/upgrade_2.4.md