Update Slugs for Java Docs (#1135)

* Update Slugs for Java Docs * Improve slugs * Fix versioned release notes links
SAP · Nov 21, 2022 · 3f1d72c · 3f1d72c
1 parent 62b538a
commit 3f1d72c
Show file tree

Hide file tree

Showing 33 changed files with 157 additions and 134 deletions.
diff --git a/...nts/sap-btp-cloud-foundry-environment.mdx → docs-java/environments/cloudfoundry.mdx b/...nts/sap-btp-cloud-foundry-environment.mdx → docs-java/environments/cloudfoundry.mdx
@@ -1,6 +1,7 @@
 ---
 title: SAP BTP Cloud Foundry Environment
-sidebar_label: SAP BTP Cloud Foundry
+sidebar_label: Cloud Foundry
+id: cloud-foundry
 description: SAP BTP Cloud Foundry environment is fully supported by the SAP Cloud SDK for Java
 keywords:
   - sap

diff --git a/...ernetes-environment-with-sap-gardener.mdx → docs-java/environments/gardener.mdx b/...ernetes-environment-with-sap-gardener.mdx → docs-java/environments/gardener.mdx
@@ -1,5 +1,6 @@
 ---
 title: Develop your App for Kubernetes with SAP Gardener and Java SDK
+id: kubernetes-gardener
 sidebar_label: Kubernetes with SAP Gardener
 description: Learn how to develop with SAP Cloud SDK for Java for Kubernetes environment backed by SAP Gardener
 keywords:

diff --git a/...environments/sap-btp-kyma-environment.mdx → docs-java/environments/kyma.mdx b/...environments/sap-btp-kyma-environment.mdx → docs-java/environments/kyma.mdx
@@ -1,6 +1,7 @@
 ---
 title: Develop your App for the Kyma Environment with Java SDK
-sidebar_label: SAP Kyma
+sidebar_label: Kubernetes with SAP Kyma
+id: kubernetes-kyma
 description: Learn how to develop an application with the SAP Cloud SDK for Java in the Kyma environment
 keywords:
   - sap
@@ -643,4 +644,4 @@ You can also refer to this additional material available for getting started wit
 
 - [Sample Application with Setup Guide](https://github.com/SAP-samples/kyma-runtime-extension-samples/tree/main/sample-cloudsdk-java)
 - [Blog Post on a Sample Use Case](https://blogs.sap.com/2022/01/11/use-sap-cloud-sdk-on-kyma-runtime-to-connect-to-external-systems-with-client-cert-authentication/)
-- [Using the Service Catalog with the SAP Cloud SDK](https://sap.github.io/cloud-sdk/docs/java/environments/sap-btp-kubernetes-environment-with-sap-gardener#excursion-bind-services-created-by-the-service-catalog)
+- [Using the Service Catalog with the SAP Cloud SDK](https://sap.github.io/cloud-sdk/docs/java/environments/kubernetes-gardener#excursion-bind-services-created-by-the-service-catalog)
diff --git a/...onments/sap-btp-environments-overview.mdx → docs-java/environments/overview.mdx b/...onments/sap-btp-environments-overview.mdx → docs-java/environments/overview.mdx
@@ -1,5 +1,6 @@
 ---
 title: SAP BTP Environments Overview
+id: overview
 sidebar_label: Overview
 description: SAP Business Technology Platform is in the epicenter of countless integration and extension scenarios. The SAP Cloud SDK provides end-to-end support for multiple environments of the SAP BTP to make sure you can develop application and extensions in convenient and effortless way.
 keywords:

diff --git a/docs-java/faq.mdx b/docs-java/faq.mdx
@@ -212,7 +212,7 @@ For feedback or questions about our Open API offering, please, create an issue [
 ### Do You Support SAP BTP, Cloud Foundry Environment?
 
 The SAP Cloud SDK for Java has first-class support for [SAP BTP, Cloud Foundry environment](https://www.sap.com/germany/products/business-technology-platform.html).
-We provide plenty of helpful abstractions for [connectivity](features/connectivity/sdk-connectivity-destination-service) and authentication that make developing apps a pleasant and rewarding experience.
+We provide plenty of helpful abstractions for [connectivity](features/connectivity/destination-service) and authentication that make developing apps a pleasant and rewarding experience.
 Let us know if you miss functionality of the SAP BTP for the Cloud Foundry environment in the SAP Cloud SDK for Java.
 
 ### Do You Support SAP Business Technology Platform - Neo?
@@ -225,7 +225,7 @@ Also, for Neo we provide out-of-the-box support with only servlet based applicat
 ### Do You Support Reactive Spring Technology, e.g. Webflux?
 
 The SAP Cloud SDK for Java currently is not fully compatible with the [Reactive Spring Technology Stack](https://docs.spring.io/spring-framework/docs/5.0.0.M1/spring-framework-reference/html/web-reactive.html).
-Most importantly, the [Multi Tenancy Features](features/multi-tenancy/multi-tenancy-thread-context) are not functional on that stack, because they were designed with servlet based applications in mind.
+Most importantly, the [Multi Tenancy Features](features/multi-tenancy/thread-context) are not functional on that stack, because they were designed with servlet based applications in mind.
 
 You can find more details on this [Stack Overflow Question](https://stackoverflow.com/questions/68177837/how-to-use-spring-webclient-properly-in-the-tenant-context).
 

diff --git a/docs-java/features/bapi-and-rfc/overview.mdx b/docs-java/features/bapi-and-rfc/overview.mdx
@@ -1,5 +1,5 @@
 ---
-id: bapi-and-rfc-overview
+id: overview
 title: Call a BAPI/RFC Module
 sidebar_label: BAPI/RFC
 description: Call a BAPI/RFC Module with the SAP Cloud SDK for Java

diff --git a/docs-java/features/connectivity/destinations.mdx b/docs-java/features/connectivity/destinations.mdx
@@ -1,5 +1,5 @@
 ---
-id: sdk-connectivity-destination-service
+id: destination-service
 title: Use Destinations To Connect To Other Systems and Services
 hide_title: false
 hide_table_of_contents: false

diff --git a/docs-java/features/connectivity/http-client.mdx b/docs-java/features/connectivity/http-client.mdx
@@ -1,5 +1,5 @@
 ---
-id: sdk-connectivity-http-client
+id: http-client
 title: Use the HttpClient Accessor To Configure Requests To Remote Services
 hide_title: false
 hide_table_of_contents: false

diff --git a/docs-java/features/connectivity/mtls.mdx b/docs-java/features/connectivity/mtls.mdx
@@ -1,5 +1,5 @@
 ---
-id: sdk-connectivity-mtls
+id: mtls
 title: Certificate-Based Authentication Using SAP Cloud SDK
 hide_title: false
 hide_table_of_contents: false

diff --git a/docs-java/features/multi-tenancy/thread-context.mdx b/docs-java/features/multi-tenancy/thread-context.mdx
@@ -1,5 +1,5 @@
 ---
-id: multi-tenancy-thread-context
+id: thread-context
 title: Multitenancy With the Thread Context
 hide_title: false
 hide_table_of_contents: false

diff --git a/docs-java/features/odata/generate-client.mdx → docs-java/features/odata/generator.mdx b/docs-java/features/odata/generate-client.mdx → docs-java/features/odata/generator.mdx
@@ -1,5 +1,5 @@
 ---
-id: generate-typed-odata-v2-and-v4-client-for-java
+id: vdm-generator
 title: Generate a Typed OData Client With the OData Generator
 hide_title: false
 hide_table_of_contents: false

diff --git a/...a/features/odata/generic-odata-client.mdx → docs-java/features/odata/generic-client.mdx b/...a/features/odata/generic-odata-client.mdx → docs-java/features/odata/generic-client.mdx
diff --git a/docs-java/features/odata/overview.mdx b/docs-java/features/odata/overview.mdx
@@ -21,18 +21,11 @@ keywords:
 [OData](https://www.odata.org/) is an open standard for building and consuming RESTful APIs.
 It defines a query language to send and retrieve data via HTTP and to perform operations on data.
 
-There are two widely used versions of the protocol: [**OData v2**](https://www.odata.org/documentation/odata-version-2-0/) and more extended and functional [**OData v4**](https://www.odata.org/documentation/).
-
-## What OData Versions do You Support?
-
-| OData protocol version                                          | SAP Cloud SDK V3 |
-| --------------------------------------------------------------- | ---------------- |
-| [OData v2](use-typed-odata-v2-client-in-sap-cloud-sdk-for-java) | &#10003;         |
-| [OData v4](use-typed-odata-v4-client-in-sap-cloud-sdk-for-java) | &#10003;         |
+There are two widely used versions of the protocol: [**OData v2**](https://www.odata.org/documentation/odata-version-2-0/) and more extended and functional [**OData v4**](https://www.odata.org/documentation/). The SAP Cloud SDK for Java supports both of these protocol versions.
 
 :::tip generate a client library yourself
 
-You can always [generate a type-safe OData client library](generate-client.mdx) based on API specifications available on the [SAP API Business Hub](https://api.sap.com/) or found elsewhere.
+You can always [generate a type-safe OData client library](vdm-generator) based on API specifications available on the [SAP API Business Hub](https://api.sap.com/) or found elsewhere.
 
 :::
 
@@ -50,13 +43,13 @@ The SAP Cloud SDK simplifies the consumption of OData services by offering:
 
 ### Generic OData Client
 
-We expose an [advanced generic OData client](./generic-odata-client.mdx) that can be leveraged when the capabilities or flexibility of a type-safe client are not enough.
+We expose an [advanced generic OData client](./generic-client.mdx) that can be leveraged when the capabilities or flexibility of a type-safe client are not enough.
 Be careful and know what you're doing.
 
 ### Code Generator
 
 If you need a client for an OData service where we do not ship a pregenerated client.
-Use our [code generator](generate-typed-odata-v2-and-v4-client-for-java) to convert its service definition into the type-safe Java client library.
+Use our [code generator](vdm-generator) to convert its service definition into the type-safe Java client library.
 You can do it for any service either developed by yourself, provided by SAP, or other third parties.
 The [SAP API Business Hub](https://api.sap.com/) is where you'll find the specification for most of the SAP-published services.
 
@@ -69,7 +62,7 @@ The [SAP API Business Hub](https://api.sap.com/) is where you'll find the specif
 
 We simplify development process on the SAP BTP by providing convenient abstractions over:
 
-- [Destinations](../connectivity/sdk-connectivity-destination-service)
+- [Destinations](../connectivity/destination-service)
 - Authentication
 - [Multi-tenancy](../multi-tenancy/thread-context.mdx)
 - and some other related concepts.

diff --git a/docs-java/features/odata/redirect-typed-client.mdx b/docs-java/features/odata/redirect-typed-client.mdx
diff --git a/...tures/odata/type-safe-client-odata-v2.mdx → docs-java/features/odata/v2-client.mdx b/...tures/odata/type-safe-client-odata-v2.mdx → docs-java/features/odata/v2-client.mdx
@@ -1,5 +1,5 @@
 ---
-id: use-typed-odata-v2-client-in-sap-cloud-sdk-for-java
+id: v2-vdm-client
 title: Use the OData v2 Type-safe Client API
 hide_title: false
 hide_table_of_contents: false
@@ -100,7 +100,7 @@ The typed OData client consists of _service_ and _data model_ classes.
 The service classes mirror the API provided by the OData service and serve as entry point for creating requests.
 They provide a builder that allows for fluently adding further parameters.
 
-To execute HTTP requests the OData client leverages _Destinations_ and are documented in more detail [here](../connectivity/sdk-connectivity-destination-service).
+To execute HTTP requests the OData client leverages _Destinations_ and are documented in more detail [here](../connectivity/destination-service).
 The following code snippets assume that such a destination is in place:
 
 ```java

diff --git a/...tures/odata/type-safe-client-odata-v4.mdx → docs-java/features/odata/v4-client.mdx b/...tures/odata/type-safe-client-odata-v4.mdx → docs-java/features/odata/v4-client.mdx
@@ -1,5 +1,5 @@
 ---
-id: use-typed-odata-v4-client-in-sap-cloud-sdk-for-java
+id: v4-vdm-client
 title: Use the OData v4 Type-safe Client API
 hide_title: false
 hide_table_of_contents: false
@@ -101,7 +101,7 @@ The typed OData v4 client consists of _service_ and _data model_ classes.
 The service classes mirror the API provided by the OData service and serve as entry point for creating requests.
 They provide a builder that allows for fluently adding further parameters.
 
-To execute HTTP requests the OData client uses _Destinations_ and are documented in more detail <a href={useBaseUrl('docs/java/features/connectivity/sdk-connectivity-destination-service')}>here</a>.
+To execute HTTP requests the OData client uses _Destinations_ and are documented in more detail <a href={useBaseUrl('docs/java/features/connectivity/destination-service')}>here</a>.
 The following code snippets assume that such a destination is in place:
 
 ```java
@@ -725,7 +725,7 @@ Please note that the OData service is not obliged to respect this setting.
 The [OData v4 standard ](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_AsynchronousRequests) has introduced means for server-side asynchronous requests.
 This feature is also supported in the [SAP Gateway Foundation](https://help.sap.com/viewer/DRAFT/68bf513362174d54b58cddec28794093/202009.latest/en-US/b9c4dd6344694418b94c4bb3bdebfee1.html).
 At the moment the SAP Cloud SDK for Java does not provide a typed API to make such requests.
-However, you can leverage our [Generic OData Client](generic-odata-client.mdx) to simplify the logic of making such requests.
+However, you can leverage our [Generic OData Client](generic-client.mdx) to simplify the logic of making such requests.
 
 :::note Process Synchronous OData Request in Asynchronous Fashion on the client side
 

diff --git a/docs-java/features/rest/generate-rest-client.mdx b/docs-java/features/rest/generate-rest-client.mdx
@@ -124,7 +124,7 @@ Maintain such a property in your POM and ensure that you always use the latest S
 
 ```xml
 <properties>
-    <!-- Use latest version always as per https://sap.github.io/cloud-sdk/docs/java/release-notes-sap-cloud-sdk-for-java -->
+    <!-- Use latest version always as per https://sap.github.io/cloud-sdk/docs/java/release-notes -->
 	<sap-cloud-sdk.version>4.XX.X</sap-cloud-sdk.version>
 </properties>
 ```

diff --git a/docs-java/guides/4.0-upgrade.mdx b/docs-java/guides/4.0-upgrade.mdx
@@ -420,7 +420,7 @@ Future runningTask = ThreadContextExecutors.submit(() -> operation());
 ```
 
 The new API also integrates conveniently with CAP and can be integrated to work with Spring's `@Async`.
-Refer to the [full documentation](../features/multi-tenancy/multi-tenancy-thread-context) for more details on these features.
+Refer to the [full documentation](../features/multi-tenancy/thread-context) for more details on these features.
 
 ## Get Support
 

diff --git a/docs-java/guides/cap-sdk-integration.mdx b/docs-java/guides/cap-sdk-integration.mdx
@@ -59,7 +59,7 @@ Here is the XML snippet:
 :::success Use the latest SAP Cloud SDK version
 
 We recommend using the **latest** SAP Cloud SDK version always.
-Check out the [release notes](../release-notes-sap-cloud-sdk-for-java) to see the release history.
+Check out the [release notes](../release-notes) to see the release history.
 
 :::
 
@@ -124,7 +124,7 @@ To still manipulate the request context, please refer to [the CAP documentation]
 :::
 
 :::note Multitenancy Integration with CAP
-You can learn more about how the multitenancy of the SAP Cloud SDK integrates with CAP in [this article](../features/multi-tenancy/multi-tenancy-thread-context#how-is-a-thread-context-created).
+You can learn more about how the multitenancy of the SAP Cloud SDK integrates with CAP in [this article](../features/multi-tenancy/thread-context#how-is-a-thread-context-created).
 Please make sure you are using a CDS version that is up to date.
 For the integration at least `1.28` is required.
 :::

diff --git a/docs-java/overview.mdx b/docs-java/overview.mdx
@@ -88,15 +88,15 @@ The image below visualises the main components of the SAP Cloud SDK for Java.
 
 ### Connectivity
 
-The SAP Cloud SDK for Java provides an API that abstracts the details of establishing connections to other systems: The [Destination API](features/connectivity/sdk-connectivity-destination-service).
+The SAP Cloud SDK for Java provides an API that abstracts the details of establishing connections to other systems: The [Destination API](features/connectivity/destination-service).
 This API makes it easy to connect to cloud and On-Premise systems with various authentication methods.
 Under the hood the SAP Cloud SDK handles all the necessary authorization and token flows that are necessary for the specific destination.
 
-You can [access destinations defined in the SAP BTP Cockpit](features/connectivity/sdk-connectivity-destination-service#accessing-destinations) directly in your code.
-Or you can define your own destinations, for example to [connect to SAP BTP services](features/connectivity/sdk-connectivity-destination-service#skip-destination-creation-step-for-certain-authentication-types-on-cloud-foundry).
+You can [access destinations defined in the SAP BTP Cockpit](features/connectivity/destination-service#accessing-destinations) directly in your code.
+Or you can define your own destinations, for example to [connect to SAP BTP services](features/connectivity/destination-service#skip-destination-creation-step-for-certain-authentication-types-on-cloud-foundry).
 
 You can then use these destinations to perform REST (OpenAPI or OData), RFC or SOAP requests.
-Or you can [get a ready-made Http Client](features/connectivity/sdk-connectivity-http-client#general-usage) for a destination to execute your own requests.
+Or you can [get a ready-made Http Client](features/connectivity/http-client#general-usage) for a destination to execute your own requests.
 
 ### OData and OpenAPI
 
@@ -165,7 +165,7 @@ For example, fetching a destination with the SAP Cloud SDK will fetch and cache
 You can access the current tenant or user and other information via the dedicated accessors, for example `TenantAccessor` and `PrincipalAccessor`.
 This enables you to run any code in a tenant aware manner.
 
-This is achieved using the concept of `ThreadContext` and you can read more about this on the dedicated guide on [Multitenancy](https://sap.github.io/cloud-sdk/docs/java/features/multi-tenancy/multi-tenancy-thread-context).
+This is achieved using the concept of `ThreadContext` and you can read more about this on the dedicated guide on [Multitenancy](https://sap.github.io/cloud-sdk/docs/java/features/multi-tenancy/thread-context).
 
 ## Further Information
 
@@ -208,4 +208,4 @@ For details, check the [release policy](release-policy).
 
 ### Support
 
-The SAP Cloud SDK is actively supported via various internal and external channels which you can find [here](support-java).
+The SAP Cloud SDK is actively supported via various internal and external channels which you can find [here](support).
diff --git a/docs-java/release-notes.mdx b/docs-java/release-notes.mdx
@@ -1,5 +1,5 @@
 ---
-id: release-notes-sap-cloud-sdk-for-java
+id: release-notes
 title: Release Notes
 sidebar_label: Release Notes
 description: Release notes of SAP Cloud SDK for Java, stay up to date with the recent features, fixes, dependency updates and recommendedations.

diff --git a/docs-java/support.mdx b/docs-java/support.mdx
@@ -1,5 +1,5 @@
 ---
-id: support-java
+id: support
 title: Support
 sidebar_label: Support
 description: If you're stuck and can't find a solution to you problem with SAP Cloud SDK, we're here to help you.

diff --git a/docs-java/troubleshooting.mdx b/docs-java/troubleshooting.mdx
@@ -1,5 +1,5 @@
 ---
-id: sdk-java-troubleshooting-frequent-problems
+id: troubleshooting-frequent-problems
 title: Troubleshooting SDK Java
 sidebar_label: Troubleshooting
 description: This article is a collection of frequently occurring symptoms and a short guidance on how to address them.
@@ -40,15 +40,15 @@ Tenant or principal information is not available or an incorrect tenant is used.
   See [JWT validation fails](#json-web-token-validation-fails).
 
 - An operation is performed in an asynchronous manner without propagating the `ThreadContext`.
-  See [Running Asynchronous Operations](features/multi-tenancy/multi-tenancy-thread-context#running-asynchronous-operations).
+  See [Running Asynchronous Operations](features/multi-tenancy/thread-context#running-asynchronous-operations).
 
 - The SAP Cloud SDK components are not registered as listeners on incoming requests.
   See [Framework Support](getting-started#framework-integration).
 
 - There was no JWT in the authorization header.
 
 - A BAPI/RFC call was attempted while using resilience or multithreading capabilities of the SAP Cloud SDK.
-  See [Subscriber Tenant Is Not Found at Runtime](features/bapi-and-rfc/bapi-and-rfc-overview#subscriber-tenant-is-not-found-at-runtime)
+  See [Subscriber Tenant Is Not Found at Runtime](features/bapi-and-rfc/overview#subscriber-tenant-is-not-found-at-runtime)
 
 ## Provider Instead of Subscriber Account Used
 
@@ -81,7 +81,7 @@ The ERP system unexpectedly responds with _401: Unauthorized_ or _403: Forbidden
 **Possible causes:**
 
 - The SAP Client and Locale headers will be missing if the `Destination` is not an `ErpHttpDestination`.
-  See [Connecting to SAP S/4HANA](features/connectivity/sdk-connectivity-destination-service#connect-to-on-premise-s4hana-system).
+  See [Connecting to SAP S/4HANA](features/connectivity/destination-service#connect-to-on-premise-s4hana-system).
 
 ## Compilation Failures in the Generated OData Virtual Data Model Classes
 
@@ -92,7 +92,7 @@ Compilation fails due to missing _Getters_ and _Setters_ on entity objects.
 **Possible causes:**
 
 - Getters and Setters will be missing if [Lombok](https://projectlombok.org/) is not present in the dependency tree of your project.
-  See [Using the OData Generator](http://localhost:3000/cloud-sdk/docs/java/features/odata/generate-typed-odata-v2-and-v4-client-for-java#using-the-odata-generator).
+  See [Using the OData Generator](http://localhost:3000/cloud-sdk/docs/java/features/odata/vdm-generator#using-the-odata-generator).
 - Getters and Setters will be shown red if your IDE does not support Lombok. Hence, install the Lombok plugin for your IDE.
   - For IntelliJ, install [the Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok).
   - For Eclipse, follow [this guide](https://projectlombok.org/setup/eclipse).

diff --git a/docs-java/video/connectivity-service.mdx b/docs-java/video/connectivity-service.mdx
@@ -16,7 +16,7 @@ Cloud-native applications are no piece of cake when you have to connect to **On-
 Well, in SAP Cloud SDK for Java we think otherwise!
 To prove it, we provide convenient abstractions over destinations to let you seamlessly connect to your **On-premise** system from your cloud app.
 What to know how?
-Watch this comprehensive video tutorial by [Max Streifeneder](https://www.youtube.com/channel/UCkzNZP9fzLxRyhnGT2ziSRw) and check our docs on [connectivity](../features/connectivity/sdk-connectivity-destination-service)
+Watch this comprehensive video tutorial by [Max Streifeneder](https://www.youtube.com/channel/UCkzNZP9fzLxRyhnGT2ziSRw) and check our docs on [connectivity](../features/connectivity/destination-service)
 
 <div class="sdk-video-container">
   <iframe