Update wording on documentation

sgayangi · sgayangi · commit 51ae54b09a71 · 2024-11-18T11:47:39.000+05:30
diff --git a/en/docs/about-apk/FAQs.md b/en/docs/about-apk/FAQs.md
@@ -25,7 +25,7 @@ Refer to the <a href="{{base_path}}/en/{{site_version}}/setup/prerequisites#prer
 
 ### 2. I want to customize some configurations in my Helm deployment. How can I do this?
 
-Refer to the <a href="{{base_path}}/en/{{site_version}}/setup/customize-configurations#customize-configurations" target="_blank">customize configurations</a> section for this information.
+Refer to the <a href="{{base_path}}/en/{{site_version}}/setup/Customize-Configurations#Customize-Configurations" target="_blank">customize configurations</a> section for this information.
 
 
 ### 3. What are the Kubernetes distributions supported by WSO2 APK?
diff --git a/en/docs/administration/configurations/configure-logs-adapter.md b/en/docs/administration/configurations/configure-logs-adapter.md
@@ -1,6 +1,6 @@
 # Adapter Log Configurations
 
-To configure Adapter logs, update the `values.yaml`'s `wso2.apk.dp.adapter.logging` section with the following values. Instructions in [Customize Configurations](../../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
+To configure Adapter logs, update the `values.yaml`'s `wso2.apk.dp.adapter.logging` section with the following values. Instructions in [Customize Configurations](../../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
 
 ```yaml
   logging:
diff --git a/en/docs/administration/configurations/configure-logs-enforcer.md b/en/docs/administration/configurations/configure-logs-enforcer.md
@@ -4,7 +4,7 @@ As the Enforcer component is implemented in Java, we are using the `log4j2` fram
 
 ## Configuring Log4j2 Properties
 
-To configure log4j2 properties, update the `values.yaml`'s `wso2.apk.dp.gatewayRuntime.deployment.enforcer.logging` section with the following values. Instructions in [Customize Configurations](../../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
+To configure log4j2 properties, update the `values.yaml`'s `wso2.apk.dp.gatewayRuntime.deployment.enforcer.logging` section with the following values. Instructions in [Customize Configurations](../../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
 
 ```yaml
 logging:
diff --git a/en/docs/administration/configurations/configure-logs-overview.md b/en/docs/administration/configurations/configure-logs-overview.md
@@ -15,7 +15,7 @@ Both these files are located in the same ConfigMap file located in the following
 apk/helm-charts/templates/data-plane/gateway-components/log-conf.yaml
 ```
 
-These configurations can be set using the `values.yaml` file. Instructions in [Customize Configurations](../../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file. Follow each section to configure the logs for each of the components.
+These configurations can be set using the `values.yaml` file. Instructions in [Customize Configurations](../../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file. Follow each section to configure the logs for each of the components.
 
 ## Error Codes in Logs 
 
diff --git a/en/docs/administration/configurations/configure-logs-router.md b/en/docs/administration/configurations/configure-logs-router.md
@@ -2,7 +2,7 @@
 
 As the APK uses an Envoy proxy as the Router component, it only supports the logging mechanisms provided by the Envoy proxy. In the following sections, you may find how to enable Router access logs and debug logs.
 
-To set up Router Logs, start by following the instructions outlined in [Customize Configurations](../../setup/customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the log configurations to your specific needs.
+To set up Router Logs, start by following the instructions outlined in [Customize Configurations](../../setup/Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the log configurations to your specific needs.
 
 ## Router Access Logging
 
diff --git a/en/docs/administration/distributed-tracing.md b/en/docs/administration/distributed-tracing.md
@@ -11,7 +11,7 @@ Supported distributed tracing systems,
 
 ## Configure Distributed Tracing
 
-To set up distributed tracing, start by following the instructions outlined in [Customize Configurations](../setup/customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the tracing configurations to your specific needs.
+To set up distributed tracing, start by following the instructions outlined in [Customize Configurations](../setup/Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the tracing configurations to your specific needs.
 
 !!! note
     If you are trying out tracing capabilities of APK and do not have an actual deployment of Jaeger or Zipkin, you can start APK together with Jaeger/Zipkin by applying  the below kubernetes artifacts to your cluster.
diff --git a/en/docs/assets/files/get-started/EmployeeServiceDefinition.json b/en/docs/assets/files/get-started/EmployeeServiceDefinition.json
@@ -6,7 +6,7 @@
     },
     "servers": [
         {
-            "url": "http://employee-service:80",
+            "url": "http://employee-service:8080",
             "description": "Server URL",
             "variables": {}
         }
diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/api-management/control-plane-create-and-deploy-graphql-apis.md b/en/docs/control-plane/apk-as-gateway-in-apim/api-management/control-plane-create-and-deploy-graphql-apis.md
@@ -1,15 +1,15 @@
-1. Save and download the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we will be using.
+1. Download and save the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we will be using.
 2. Login to the Publisher Console [API Publisher](https://am.wso2.com/publisher) of the WSO2 API Manager.
 3. Under the GraphQL option, use `Import GraphQL SDL` option.
 4. Provide the GraphQL definition of the API that was downloaded in step 1 and click `Next`. 
 5. Provide the following information.
 
-   | Field    | Sample value                                |
-   |----------|---------------------------------------------|
-   | Name     | StarWarsAPI                                 |
-   | Context  | /starwars                                   |
-   | Version  | 1.0.0                                       |
-   | Endpoint | http://graphql-faker-service:9002/graphql   |
+   | Field    | Sample value                              |
+   | -------- | ----------------------------------------- |
+   | Name     | StarWarsAPI                               |
+   | Context  | /starwars                                 |
+   | Version  | 1.0.0                                     |
+   | Endpoint | http://graphql-faker-service:9002/graphql |
 
 6. Select the APK Gateway and click Create.
 7. Navigate to the Deploy section and click Deployments.
diff --git a/en/docs/control-plane/deploy-apim-apk-agent.md b/en/docs/control-plane/deploy-apim-apk-agent.md
@@ -37,7 +37,7 @@ Follow the instructions below to deploy the APIM APK Agent.
     ```
 
 !!! Optional
-To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
+To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
 
 === "Command"
     ```
diff --git a/en/docs/create-api/create-and-attach-api-policies/cors/enable-cors-via-rest-api.md b/en/docs/create-api/create-and-attach-api-policies/cors/enable-cors-via-rest-api.md
@@ -75,7 +75,7 @@ Sample content before the modification is shown below.
   defaultVersion: false
   endpointConfigurations:
     production:
-      endpoint: "http://employee-service:80"
+      endpoint: "http://employee-service:8080"
   operations:
     - target: "/employee"
       verb: "GET"
diff --git a/en/docs/create-api/create-and-deploy-apis/graphql/create-graphql-api-using-rest-api.md b/en/docs/create-api/create-and-deploy-apis/graphql/create-graphql-api-using-rest-api.md
@@ -23,7 +23,7 @@ kubectl get pods -n <namespace>
 
 Follow the instructions below to design a GraphQL API.
 
-1. Save and download the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we are going to deploy in APK.
+1. Download and save the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we are going to deploy in APK.
 
 2. Execute the following request to generate the APK configuration. Use the values provided in the table below in the body of your request. 
 
diff --git a/en/docs/get-started/quick-start-guide-as-gateway.md b/en/docs/get-started/quick-start-guide-as-gateway.md
@@ -7,10 +7,10 @@ This section is a step-by-step guide to creating, deploying, and invoking an API
 
 ## Before you begin...
 
-Install the [prerequisites](../../setup/prerequisites) that are required to run the WSO2 API Platform For Kubernetes.
+Install the <a href="../../setup/prerequisites" target="_blank">prerequisites</a> that are required to run the WSO2 API Platform for Kubernetes.
 
 !!!NOTE
-    If you already have an installation of the APK in your cluster, please remove the installation by following the steps specified in the [Uninstall APK](../setup/uninstall.md) section.
+    If you already have an installation of the APK in your cluster, please remove the installation by following the steps specified in the <a href="../../setup/uninstall" target="_blank">Uninstall APK</a> section.
 
 ### Create Kubernetes namespace
 
diff --git a/en/docs/get-started/quick-start-guide-with-cp.md b/en/docs/get-started/quick-start-guide-with-cp.md
@@ -21,7 +21,7 @@ Install the <a href="../../setup/prerequisites" target="_blank">prerequisites</a
 
 ## Step 2 - Create and Deploy the API From Dataplane
 
-1. Save and download the sample 
+1. Download and save the sample 
 <a href="https://raw.githubusercontent.com/wso2/docs-apk/refs/heads/1.2.0/en/docs/assets/files/get-started/EmployeeServiceDefinition.json" 
    target="_blank"  onclick="downloadFile(event)">EmployeeServiceDefinition.json</a> file. This is the OAS definition of the API that we are going to deploy in APK.
 2. Add a hostname mapping to the ```/etc/hosts``` file as follows.
@@ -73,7 +73,7 @@ Apart from the above API definition file, we also need an `apk-conf` file that d
         defaultVersion: false
         endpointConfigurations:
             production:
-                endpoint: "http://employee-service:80"
+                endpoint: "http://employee-service:8080"
         operations:
         - target: "/employees"
           verb: "GET"
@@ -180,7 +180,7 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c
 
 ## Step 3 - Create the Backend
 
-The endpoint "http://employee-service:80" provided in the above files points to a backend deployed on a kubernetes service. Prior to invoking the API, you will need to have this backend up. 
+The endpoint "http://employee-service:8080" provided in the above files points to a backend deployed on a kubernetes service. Prior to invoking the API, you will need to have this backend up. 
 
 We have provided the file containing this sample backend [here](https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/qsg-sample-backend.yaml). You can create the backend service using the following command.
 
diff --git a/en/docs/get-started/quick-start-guide.md b/en/docs/get-started/quick-start-guide.md
@@ -34,7 +34,7 @@ kubectl get pods
 
 ## Step 3 - Create and Deploy the API
 
-1. Save and download the sample 
+1. Download and save the sample 
 <a href="https://raw.githubusercontent.com/wso2/docs-apk/refs/heads/1.1.0/en/docs/assets/files/get-started/EmployeeServiceDefinition.json" 
    target="_blank"  onclick="downloadFile(event)">EmployeeServiceDefinition.json</a> <script src="download.js"></script> file. This is the OAS definition of the API that we are going to deploy in APK.
 2. Add a hostname mapping to the ```/etc/hosts``` file as follows.
@@ -84,7 +84,7 @@ Apart from the above API definition file, we also need an `apk-conf` file that d
         defaultVersion: false
         endpointConfigurations:
             production:
-                endpoint: "http://employee-service:80"
+                endpoint: "http://employee-service:8080"
         operations:
         - target: "/employee"
             verb: "GET"
@@ -191,7 +191,7 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c
         defaultVersion: false
         endpointConfigurations:
             production:
-                endpoint: "http://employee-service:80"
+                endpoint: "http://employee-service:8080"
         operations:
         - target: "/employees"
           verb: "GET"
diff --git a/en/docs/includes/create-apk-conf-api.md b/en/docs/includes/create-apk-conf-api.md
@@ -20,7 +20,7 @@ kubectl get pods
 
 You will need an OpenAPI Specification 3.x that describes the structure and behavior of your API. This file serves as the foundation for configuring your API and is essential for generating the APK Configuration file.
 
-Save and download the sample [EmployeeServiceDefinition.json](https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/definitions/EmployeeServiceDefinition.json) file. This is the OAS definition of the API that we are going to deploy in APK.
+Download and save the sample [EmployeeServiceDefinition.json](https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/definitions/EmployeeServiceDefinition.json) file. This is the OAS definition of the API that we are going to deploy in APK.
 
 ## Step 3. Generate APK configuration file.
     
@@ -59,7 +59,7 @@ type: "REST"
 defaultVersion: false
 endpointConfigurations:
     production:
-        endpoint: "http://employee-service:80"
+        endpoint: "http://employee-service:8080"
 operations:
 - target: "/employees"
     verb: "GET"
diff --git a/en/docs/includes/customize-installation.md b/en/docs/includes/customize-installation.md
@@ -1,4 +1,4 @@
-To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
+To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
 
     === "Command"
         ```
diff --git a/en/docs/includes/direct-deploy.md b/en/docs/includes/direct-deploy.md
@@ -21,7 +21,7 @@ organization: "default"
 defaultVersion: false
 endpointConfigurations:
     production:
-        endpoint: "http://employee-service:80"
+        endpoint: "http://employee-service:8080"
 operations:
 - target: "/employee"
     verb: "GET"
diff --git a/en/docs/setup/analytics/configure-analytics-for-choreo-insights.md b/en/docs/setup/analytics/configure-analytics-for-choreo-insights.md
@@ -22,7 +22,7 @@
         kubectl create secret generic <secret-name> --from-literal=authToken='<choreo-on-prem-key>' --from-literal=authURL='https://analytics-event-auth.choreo.dev/auth/v1' -n <namespace>
         ```
 
-2. Follow the instructions outlined in [Customize Configurations](../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the analytics configurations to your specific needs. 
+2. Follow the instructions outlined in [Customize Configurations](../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file, which you will then use to tailor the analytics configurations to your specific needs. 
 3. Replace `secret-name` in the following configuration with the name of the secret you created in the previous step.
 ```yaml
 analytics:
diff --git a/en/docs/setup/analytics/configure-analytics-for-elk-stack.md b/en/docs/setup/analytics/configure-analytics-for-elk-stack.md
@@ -2,7 +2,7 @@
 
 ## Step 1 - Setup APK
 
-1. Start by following the instructions outlined in [Customize Configurations](../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.
+1. Start by following the instructions outlined in [Customize Configurations](../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.
    
 2. Open the `values.yaml` file, and add the configuration given below to the `gatewayRuntime` section under `dp`. 
 ```yaml
diff --git a/en/docs/setup/analytics/configure-analytics-for-moesif.md b/en/docs/setup/analytics/configure-analytics-for-moesif.md
@@ -19,7 +19,7 @@
         kubectl create secret generic <secret-name> --from-literal=moesifToken='<moesif-collector-application-id>' -n <namespace>
         ```
 
-2. Follow the instructions outlined in [Customize Configurations](../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.
+2. Follow the instructions outlined in [Customize Configurations](../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file.
    
 3. Replace ```secret-name``` in the following configuration with the name of the secret you created in the previous step.
 
diff --git a/en/docs/setup/configure-hpa.md b/en/docs/setup/configure-hpa.md
@@ -4,7 +4,7 @@ When the traffic to your pods increase, the deployment may need to scale horizon
 
 To configure HPA for gateway, follow these steps.
 
-1. Obtain the `values.yaml` file for your deployment by following the instructions in [Customize Configurations](../setup/customize-configurations.md).
+1. Obtain the `values.yaml` file for your deployment by following the instructions in [Customize Configurations](../setup/Customize-Configurations.md).
 2. Update the following configuration with your required values.
 ```
 autoscaling:
diff --git a/en/docs/setup/enterprise-apim-apk-agent-install.md b/en/docs/setup/enterprise-apim-apk-agent-install.md
@@ -53,7 +53,7 @@ Install the [prerequisites](../../setup/prerequisites) that are required to run
     ```
 
 !!! Optional
-    To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
+    To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
         
     === "Command"
          ```
diff --git a/en/docs/setup/enterprise-apk-install.md b/en/docs/setup/enterprise-apk-install.md
@@ -53,7 +53,7 @@ Install the [prerequisites](../../setup/prerequisites) that are required to run
     ```
 
 !!! Optional
-    To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
+    To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
         
     === "Command"
          ```
diff --git a/en/docs/setup/identity-platform/idp/asgardeo-idp.md b/en/docs/setup/identity-platform/idp/asgardeo-idp.md
@@ -107,7 +107,7 @@ Follow the instructions below to use Asgardeo as the Identity Provider (IdP) to
 
         ## Step 5 - Update the Helm Chart
 
-        1. Follow the instructions outlined in [Customize Configurations](../../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
+        1. Follow the instructions outlined in [Customize Configurations](../../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
         2. Update the IDP related configurations in the `idp` section.
         3. Create a K8s Secret with retrieved `clientId` and `clientSecret` from Step 4 with name `apk-idp-secret`.
               ```
diff --git a/en/docs/setup/identity-platform/idp/auth0-idp.md b/en/docs/setup/identity-platform/idp/auth0-idp.md
@@ -142,7 +142,7 @@ You need to add a [custom claim](https://auth0.com/docs/secure/tokens/json-web-t
 
         ## Step 6 - Update the Helm Chart
         
-        1. Follow the instructions outlined in [Customize Configurations](../../customize-configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
+        1. Follow the instructions outlined in [Customize Configurations](../../Customize-Configurations.md). These instructions will guide you through the process of acquiring the `values.yaml` file. Open the `values.yaml` file.
         2. Update the IDP related configurations in the `idp` section.
         3. Create a K8s Secret with retrieved `clientId` and `clientSecret` from Step 4 with name `apk-idp-secret`.
 
diff --git a/en/docs/setup/identity-platform/idp/third-party-idp.md b/en/docs/setup/identity-platform/idp/third-party-idp.md
diff --git a/en/docs/setup/production-deployment-guideline.md b/en/docs/setup/production-deployment-guideline.md

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`},`
`7`	`7`	`"servers": [`
`8`	`8`	`{`
`9`		`- "url": "http://employee-service:80",`
	`9`	`+ "url": "http://employee-service:8080",`
`10`	`10`	`"description": "Server URL",`
`11`	`11`	`"variables": {}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/customize-configurations.md) will guide you through the process of acquiring the `values.yaml` file.
	`1`	+To commence the installation while making use of the customization capabilities inherent in the `values.yaml` file, follow the subsequent command format. Instructions in [Customize Configurations](../setup/Customize-Configurations.md) will guide you through the process of acquiring the `values.yaml` file.
`2`	`2`
`3`	`3`	`=== "Command"`
`4`	`4`	```