Fix local links

aversey · aversey · commit 028e4c539189 · 2025-12-02T13:43:32.000+01:00
diff --git a/docs/concepts/fs/feature_group/fg_statistics.md b/docs/concepts/fs/feature_group/fg_statistics.md
@@ -6,7 +6,7 @@ HSFS supports monitoring, validation, and alerting for features:
 
 ### Statistics
 
-When you create a Feature Group in HSFS, you can configure it to compute statistics over the features inserted into the Feature Group by setting the `statistics_config` dict parameter, see [Feature Group Statistics](../../../../user_guides/fs/feature_group/statistics/) for details.
+When you create a Feature Group in HSFS, you can configure it to compute statistics over the features inserted into the Feature Group by setting the `statistics_config` dict parameter, see [Feature Group Statistics](../../../user_guides/fs/feature_group/statistics.md) for details.
 Every time you write to the Feature Group, new statistics will be computed over all of the data in the Feature Group.
 
 ### Data Validation
diff --git a/docs/setup_installation/admin/auth.md b/docs/setup_installation/admin/auth.md
@@ -28,10 +28,10 @@ In the **Cluster Settings** _Authentication_ tab you can configure how users aut
 
 2. **OAuth2**: if your organization already have an identity management system compatible with [OpenID Connect (OIDC)](https://openid.net/connect/) you can configure Hopsworks to use your identity provider by enabling **OAuth** as shown in the figure below.
    After enabling OAuth you can register your identity provider by clicking on **Add Identity Provider** button.
-   See [Create client](../oauth2/create-client) for details.
+   See [Create client](./oauth2/create-client.md) for details.
 3. **LDAP/Kerberos**: if your organization is using LDAP or Kerberos to manage users and services you can configure Hopsworks to use it as the user management system.
    You can enable LDAP/Kerberos by clicking on the checkbox, as shown in the figure below, and choosing LDAP or Kerberos.
-   For more information on how to configure LDAP and Kerberos see [Configure LDAP](../ldap/configure-ldap) and [Configure Kerberos](../ldap/configure-krb).
+   For more information on how to configure LDAP and Kerberos see [Configure LDAP](./ldap/configure-ldap.md) and [Configure Kerberos](./ldap/configure-krb.md).
 
 <figure>
   <img src="../../../assets/images/admin/auth-config.png" alt="Authentication config" />
diff --git a/docs/setup_installation/admin/ldap/configure-krb.md b/docs/setup_installation/admin/ldap/configure-krb.md
@@ -10,7 +10,7 @@ Kerberos need some server configuration before you can enable it from the UI.
 ## Prerequisites
 
 A server configured with Kerberos.
-See [Server Configuration for Kerberos](../configure-server/#server-configuration-for-kerberos) for instruction on how to do this.
+See [Server Configuration for Kerberos](./configure-server.md#step-2-server-configuration-for-kerberos) for instruction on how to do this.
 
 ### Step 1: Enable Kerberos
 
@@ -35,7 +35,7 @@ Finally, click on edit configuration and fill in the attributes.
 </figure>
 
 - Account status: the status a user will be assigned when logging in for the first time.
-  If a user is assigned a status different from *Activated* an admin needs to manually activate each user from the [User management](../../user).
+  If a user is assigned a status different from *Activated* an admin needs to manually activate each user from the [User management](../user.md).
 - Group mapping: allows you to specify a mapping between LDAP groups and Hopsworks groups.
   The mapping is a semicolon separated string in the form ```Directory Administrators->HOPS_ADMIN;IT People-> HOPS_USER```.
   Default is empty.
diff --git a/docs/setup_installation/admin/ldap/configure-ldap.md b/docs/setup_installation/admin/ldap/configure-ldap.md
@@ -10,7 +10,7 @@ LDAP need some server configuration before you can enable it from the UI.
 ## Prerequisites
 
 A server configured with LDAP.
-See [Server Configuration for LDAP](../configure-server/#server-configuration-for-ldap) for instruction on how to do this.
+See [Server Configuration for LDAP](./configure-server.md#step-1-server-configuration-for-ldap) for instruction on how to do this.
 
 ### Step 1: Enable LDAP
 
@@ -34,7 +34,7 @@ Finally, click on edit configuration and fill in the attributes.
 </figure>
 
 - Account status: the status a user will be assigned when logging in for the first time.
-  If a user is assigned a status different from *Activated* an admin needs to manually activate each user from the [User management](../../user).
+  If a user is assigned a status different from *Activated* an admin needs to manually activate each user from the [User management](../user.md).
 - Group mapping: allows you to specify a mapping between LDAP groups and Hopsworks groups.
   The mapping is a semicolon separated string in the form ```Directory Administrators->HOPS_ADMIN;IT People-> HOPS_USER```.
   Default is empty.
diff --git a/docs/setup_installation/admin/ldap/configure-project-mapping.md b/docs/setup_installation/admin/ldap/configure-project-mapping.md
@@ -11,7 +11,7 @@ For example, if a user is removed from the LDAP group, they will also be removed
 
 ## Prerequisites
 
-1. A server configured with LDAP or Kerberos. See [Server Configuration for Kerberos](../configure-server/#server-configuration-for-kerberos) and [Server Configuration for LDAP](../configure-server/#server-configuration-for-ldap) for instructions on how to do this.
+1. A server configured with LDAP or Kerberos. See [Server Configuration for Kerberos](./configure-server.md#step-2-server-configuration-for-kerberos) and [Server Configuration for LDAP](./configure-server.md#step-1-server-configuration-for-ldap) for instructions on how to do this.
 2. LDAP group mapping sync enabled. This can be done by setting the variable ```ldap_group_mapping_sync_enabled=true```.
 
 See [Cluster Configuration](../variables.md) on how to change variable values in Hopsworks.
diff --git a/docs/setup_installation/admin/monitoring/export-metrics.md b/docs/setup_installation/admin/monitoring/export-metrics.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-Hopsworks services produce metrics which are centrally gathered by [Prometheus](https://prometheus.io/) and visualized in [Grafana](../grafana).
+Hopsworks services produce metrics which are centrally gathered by [Prometheus](https://prometheus.io/) and visualized in [Grafana](./grafana.md).
 Although the system is self-contained, it is possible for another *federated* Prometheus instance to scrape these metrics or directly push them to another system.
 This is useful if you have a centralized monitoring system with already configured alerts.
 
diff --git a/docs/setup_installation/admin/oauth2/configure-project-mapping.md b/docs/setup_installation/admin/oauth2/configure-project-mapping.md
@@ -1,13 +1,13 @@
 # Configure OAuth2 group to project mapping
- 
+
 ## Introduction
 A group-to-project mapping lets you automatically add all members of an OAuth2 group to a project, eliminating the need to add each user individually. To create a mapping, you simply select an OAuth2 group, choose the project it should be linked to, and assign the role that its members will have within that project.
 
 Once a mapping is created, project membership is controlled through OAuth2 group membership. Any updates made to the OAuth2 group—such as adding or removing users—will automatically be reflected in Hopsworks. For example, if a user is removed from the OAuth2 group, they will also be removed from the corresponding project.
- 
+
 ## Prerequisites
-1. A server configured with OAuth2. See [Register Identity Provider in Hopsworks](../create-client) for instructions on how to do this.
-2. OAuth2 group mapping sync enabled. This can be done by setting the variable ```oauth_group_mapping_sync_enabled=true```. 
+1. A server configured with OAuth2. See [Register Identity Provider in Hopsworks](./create-client.md) for instructions on how to do this.
+2. OAuth2 group mapping sync enabled. This can be done by setting the variable ```oauth_group_mapping_sync_enabled=true```.
 See [Cluster Configuration](../variables.md) on how to change variable values in Hopsworks.
 <figure>
  <a  href="../../../../assets/images/admin/project-mapping/configuration-variables.png">
@@ -24,61 +24,61 @@ If you can not find the variable ```oauth_group_mapping_sync_enabled``` create i
  </a>
  <figcaption>Create OAuth2 mapping enabled variable</figcaption>
 </figure>
- 
+
 ### Step 1: Create a mapping
 To create a mapping go to **Cluster Settings** by clicking on your name in the top right
 corner of the navigation bar and choosing *Cluster Settings* from the dropdown menu.
 In the _Project mapping_ tab, you can create a new mapping by clicking on _Create new mapping_.
- 
+
 <figure>
  <a  href="../../../../assets/images/admin/project-mapping/project-mapping-empty.png">
    <img src="../../../../assets/images/admin/project-mapping/project-mapping-empty.png" alt="Project mapping tab" />
  </a>
  <figcaption>Project mapping</figcaption>
 </figure>
- 
+
 This will take you to the create mapping page shown below
 <figure>
  <a  href="../../../../assets/images/admin/project-mapping/create-oauth-mapping.png">
    <img src="../../../../assets/images/admin/project-mapping/create-oauth-mapping.png" alt="Create mapping" />
  </a>
  <figcaption>Create mapping</figcaption>
 </figure>
- 
+
 Here you can enter your OAuth2 group and map it to a project from the _Project_ drop down list.
 You can also choose the _Project role_ users will be assigned when they are added to the project.
- 
+
 Finally, click on _Create mapping_ and go back to mappings. You should see the newly created mapping(s) as shown below.
- 
+
 <figure>
  <a  href="../../../../assets/images/admin/project-mapping/group-to-project-mappings.png">
    <img src="../../../../assets/images/admin/project-mapping/group-to-project-mappings.png" alt="Project mappings" />
  </a>
  <figcaption>Project mappings</figcaption>
 </figure>
- 
+
 !!!Note
-    Make sure the group names from your OAuth2 provider match the one you entered above. 
+    Make sure the group names from your OAuth2 provider match the one you entered above.
 
     If your identity provider uses a claim name other than ```groups``` or ```roles``` to represent group information, be sure to specify that claim name in the **Group Claim** field when setting up your identity provider.
-  
+
 ### Step 2: Edit a mapping
- 
+
 From the list of mappings click on the edit button (:material-pencil:). This will open a popup that will allow you to change the _remote group_, _project name_, and _project role_ of a mapping.
- 
+
 <figure>
  <a  href="../../../../assets/images/admin/project-mapping/edit-mapping.png">
    <img src="../../../../assets/images/admin/project-mapping/edit-mapping.png" alt="Edit mapping" />
  </a>
  <figcaption>Edit mapping</figcaption>
 </figure>
- 
+
 !!!Warning
     Updating a mapping's _remote group_ or _project name_ will remove all members of the previous group from the project.
- 
+
 ### Step 3: Delete a mapping
- 
+
 To delete a mapping click on the delete button.
- 
+
 !!!Warning
     Deleting a mapping will remove all members of that group from the project.
diff --git a/docs/setup_installation/admin/oauth2/create-azure-client.md b/docs/setup_installation/admin/oauth2/create-azure-client.md
@@ -40,7 +40,7 @@ Click Register.
 ### Step 2: Get the necessary fields for client registration
 
 In the Overview section, copy the *Application (client) ID field*.
-We will use it in [Identity Provider registration](../create-client) under the name *Client id*.
+We will use it in [Identity Provider registration](./create-client.md) under the name *Client id*.
 
 <p align="center">
   <figure>
@@ -50,7 +50,7 @@ We will use it in [Identity Provider registration](../create-client) under the n
 </p>
 
 Click on *Endpoints* and copy the *OpenId Connect metadata document* endpoint excluding the *.well-known/openid-configuration* part.
-We will use it in [Identity Provider registration](../create-client) under the name *Connection URL*.
+We will use it in [Identity Provider registration](./create-client.md) under the name *Connection URL*.
 
 <p align="center">
   <figure>
@@ -90,7 +90,7 @@ Click *Add*.
 </p>
 
 Copy the secret.
-This will be used in [Identity Provider registration](../create-client) under the name *Client Secret*.
+This will be used in [Identity Provider registration](./create-client.md) under the name *Client Secret*.
 
 <p align="center">
   <figure>
diff --git a/docs/setup_installation/admin/oauth2/create-client.md b/docs/setup_installation/admin/oauth2/create-client.md
@@ -3,15 +3,15 @@
 ## Introduction
 
 Before registering your identity provider in Hopsworks you need to create a client application in your identity provider and acquire a _client id_ and a _client secret_.
-An example on how to create a client using [Okta](https://www.okta.com/) and [Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview) identity providers can be found in the following guides: [Create Okta Client](../create-okta-client) and [Create Azure Client](../create-azure-client).
+An example on how to create a client using [Okta](https://www.okta.com/) and [Azure Active Directory](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview) identity providers can be found in the following guides: [Create Okta Client](./create-okta-client.md) and [Create Azure Client](./create-azure-client.md).
 
 ## Prerequisites
 
 Acquired a _client id_ and a _client secret_ from your identity provider.
 
 ### Step 1: Register a client
 
-After acquiring the _client id_ and _client secret_ create the client in Hopsworks by [enabling OAuth2](../../auth) and clicking on _add another identity provider_ in the [Authentication configuration page](../../auth).
+After acquiring the _client id_ and _client secret_ create the client in Hopsworks by [enabling OAuth2](../auth.md) and clicking on _add another identity provider_ in the [Authentication configuration page](../auth.md).
 Then set base uri of your identity provider in _Connection URL_ give a name to your identity provider (the name will be used in the login page as an alternative login method) and set the _client id_ and _client secret_ in their respective fields, as shown in the figure below.
 
 <figure>
diff --git a/docs/setup_installation/admin/oauth2/create-okta-client.md b/docs/setup_installation/admin/oauth2/create-okta-client.md
@@ -47,7 +47,7 @@ You can also create mappings from groups in Okta to groups in Hopsworks.
 To achieve this you need to configure Okta to send _Groups_ with user information.
 To do this go to _Applications_ and select your application name.
 In the _Sign On_ tab click edit _OpenID Connect ID Token_ and select **Filter** for _Groups claim type_, then for _Groups claim filter_ add **groups** as the claim name, select **Match Regex** from the dropdown and .* (dot star) as Regex to match all groups.
-See [Group mapping](../create-client/#group-mapping) on how to do the mapping in Hopsworks.
+See [Group mapping](./create-client.md#group-mapping) on how to do the mapping in Hopsworks.
 
   <figure>
     <img src="../../../../assets/images/admin/oauth2/okta-groups.png" alt="Group claim" />
@@ -57,7 +57,7 @@ See [Group mapping](../create-client/#group-mapping) on how to do the mapping in
 ### Step 2: Get the necessary fields for client registration
 
 After the application is created go back to _Applications_ and click on the application you just created.
-Use the _Okta domain_ (_Connection URL_), _client id_ and _client secret_ generated for your app in the [Identity Provider registration](../create-client) in Hopsworks.
+Use the _Okta domain_ (_Connection URL_), _client id_ and _client secret_ generated for your app in the [Identity Provider registration](./create-client.md) in Hopsworks.
 
   <figure>
     <img src="../../../../assets/images/admin/oauth2/overview.png" alt="Application overview" />
@@ -66,4 +66,4 @@ Use the _Okta domain_ (_Connection URL_), _client id_ and _client secret_ genera
 
 !!! note
 
-    When copying the domain in the figure above make sure to add the url scheme (http:// or https://) when using it in the _Connection URL_ in the [Identity Provider registration form](../create-client).
+    When copying the domain in the figure above make sure to add the url scheme (http:// or https://) when using it in the _Connection URL_ in the [Identity Provider registration form](./create-client.md).
diff --git a/docs/setup_installation/admin/roleChaining.md b/docs/setup_installation/admin/roleChaining.md
@@ -138,4 +138,4 @@ And click on _Create new role chaining_
 Project member can now create connectors using _temporary credentials_ to assume the role you configured.
 More details about using temporary credentials can be found in the [Temporary Credentials section](../../user_guides/fs/data_source/creation/s3.md#temporary-credentials) of the S3 datasource creation guide.
 
-Project member can see the list of role they can assume by going the _Project Settings_ -> [Assuming IAM Roles](../../../user_guides/projects/iam_role/iam_role_chaining) page.
+Project member can see the list of role they can assume by going the _Project Settings_ -> [Assuming IAM Roles](../../user_guides/projects/iam_role/iam_role_chaining.md) page.
diff --git a/docs/setup_installation/admin/user.md b/docs/setup_installation/admin/user.md
@@ -24,7 +24,7 @@ Roles let you manage the access rights of a user to the cluster.
 
 - User: users with this role are only allowed to use the cluster by creating a limited number of projects.
 - Admin: users with this role are allowed to manage the cluster.
-  This includes accepting new users to the cluster or blocking them, managing user quota, [configure alerts](../alert) and setting up [authentication methods](../auth).
+  This includes accepting new users to the cluster or blocking them, managing user quota, [configure alerts](./alert.md) and setting up [authentication methods](./auth.md).
 
 You can change the role of a user by clicking on the _select dropdown_ that shows the current role of the user.
 
diff --git a/docs/setup_installation/common/arrow_flight_duckdb.md b/docs/setup_installation/common/arrow_flight_duckdb.md
@@ -10,7 +10,7 @@ and batch inference data from the Feature Store, as well as creating moderately-
 When the service is enabled, clients will automatically use it for the following operations:
 
 - [reading Feature Groups][hsfs.feature_group.FeatureGroup.read]
-- [reading Queries][hsfs.query.Query.read]
+- [reading Queries][hsfs.constructor.query.Query.read]
 - [reading Training Datasets][hsfs.feature_view.FeatureView.get_training_data]
 - [creating In-Memory Training Datasets](https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#training_data)
 - [reading Batch Inference Data](https://docs.hopsworks.ai/hopsworks-api/{{{hopsworks_version}}}/generated/api/feature_view_api/#get_batch_data)
diff --git a/docs/user_guides/client_installation/index.md b/docs/user_guides/client_installation/index.md
@@ -52,7 +52,7 @@ If you want to interact with the Hopsworks Feature Store from environments such
 
     The Java library only allows interaction with the Feature Store component of the Hopsworks platform.
     Additionally each environment might restrict the supported API operation.
-    You can see which API operation is supported by which environment [here](../fs/compute_engines)
+    You can see which API operation is supported by which environment [here](./fs/compute_engines.md)
 
 The HSFS library is available on the Hopsworks' Maven repository.
 If you are using Maven as build tool, you can add the following in your `pom.xml` file:
diff --git a/docs/user_guides/projects/auth/krb.md b/docs/user_guides/projects/auth/krb.md
@@ -8,7 +8,7 @@ Here we will look at authentication using Kerberos.
 ## Prerequisites
 
 A Hopsworks cluster with Kerberos authentication.
-See [Configure Kerberos](../../../../setup_installation/admin/ldap/configure-krb) on how to configure Kerberos on your cluster.
+See [Configure Kerberos](../../../setup_installation/admin/ldap/configure-krb.md) on how to configure Kerberos on your cluster.
 
 ### Step 1: Log in with Kerberos
 
@@ -62,4 +62,4 @@ After clicking on **Register** you will be redirected to the landing page:
 
 In the landing page, you will find two buttons.
 Use these buttons to either create a
-_demo project_ or [a new project](../../../projects/project/create_project).
+_demo project_ or [a new project](../../projects/project/create_project.md).
diff --git a/docs/user_guides/projects/auth/ldap.md b/docs/user_guides/projects/auth/ldap.md
@@ -8,7 +8,7 @@ Here we will look at authentication using LDAP.
 ## Prerequisites
 
 A Hopsworks cluster with LDAP authentication.
-See [Configure LDAP](../../../../setup_installation/admin/ldap/configure-ldap) on how to configure LDAP on your cluster.
+See [Configure LDAP](../../../setup_installation/admin/ldap/configure-ldap.md) on how to configure LDAP on your cluster.
 
 ### Step 1: Log in with LDAP
 
@@ -46,4 +46,4 @@ After clicking on **Register** you will be redirected to the landing page:
 
 In the landing page, you will find two buttons.
 Use these buttons to either create a
-_demo project_ or [a new project](../../../projects/project/create_project).
+_demo project_ or [a new project](../../projects/project/create_project.md).
diff --git a/docs/user_guides/projects/auth/login.md b/docs/user_guides/projects/auth/login.md
@@ -40,4 +40,4 @@ Upon successful login, you will arrive at the landing page:
 
 In the landing page, you will find two buttons.
 Use these buttons to either create a
-_demo project_ or [a new project](../../../projects/project/create_project).
+_demo project_ or [a new project](../../projects/project/create_project.md).
diff --git a/docs/user_guides/projects/auth/oauth.md b/docs/user_guides/projects/auth/oauth.md
diff --git a/docs/user_guides/projects/iam_role/iam_role_chaining.md b/docs/user_guides/projects/iam_role/iam_role_chaining.md
