From 6f225380641a9418631712c47bd546d09ebb6034 Mon Sep 17 00:00:00 2001 From: Roee Toledano Date: Thu, 11 Jul 2024 16:49:08 +0300 Subject: [PATCH] [DX-1437] customise --> customize (PR 1) (#5059) customise 1 --- .../advanced-configuration/transform-traffic.md | 4 ++-- .../transform-traffic/response-headers.md | 2 +- .../tyk-oas-api-definition/tyk-oas-middleware.md | 2 +- .../report-monitor-trigger-events/webhooks.md | 2 +- .../configure/outbound-email-configuration.md | 12 ++++++------ .../custom-developer-portal-options.md | 2 +- .../redis-persistence-using-containers.md | 2 +- .../ensure-high-availability/enforced-timeouts.md | 2 +- tyk-docs/content/plugins/supported-languages.md | 2 +- .../supported-languages/javascript-middleware.md | 2 +- .../middleware-scripting-guide.md | 2 +- .../rich-plugins/grpc/custom-auth-python.md | 4 ++-- .../rich-plugins/grpc/request-transformation-java.md | 2 +- .../rich-plugins/grpc/write-grpc-plugin.md | 4 ++-- .../install-portal-using-docker-compose.md | 4 ++-- .../install-portal-using-docker.md | 6 +++--- .../install-portal-using-rpm.md | 4 ++-- .../portal-customisation/configure-webhooks.md | 2 +- .../portal-customisation/customise-user-model.md | 12 ++++++------ .../content/shared/create-portal-entry-include.md | 2 +- .../content/shared/tyk-gateway-features-include.md | 2 +- .../using-plugins/setup-control-plane.md | 2 +- tyk-docs/content/tyk-cloud/initial-portal-config.md | 2 +- tyk-docs/content/tyk-dashboard.md | 2 +- tyk-docs/content/tyk-developer-portal.md | 2 +- tyk-docs/content/tyk-on-premises.md | 2 +- .../tyk-on-premises/installation/on-heroku.md | 4 ++-- .../customise-enterprise-portal.md | 2 +- .../full-customisation/content-manager-workflow.md | 2 +- .../full-customisation/developer-workflow.md | 8 ++++---- .../full-customisation/email-customization.md | 8 ++++---- .../full-customisation/file-structure-concepts.md | 2 +- .../full-customisation/full-customisation.md | 6 +++--- .../full-customisation/menus-customisation.md | 2 +- .../quick-customisation.md | 4 ++-- .../customise-menus.md | 6 +++--- .../other-data-stores/monitor-apis-prometheus.md | 2 +- tyk-docs/content/upgrading-tyk.md | 2 +- 38 files changed, 67 insertions(+), 67 deletions(-) diff --git a/tyk-docs/content/advanced-configuration/transform-traffic.md b/tyk-docs/content/advanced-configuration/transform-traffic.md index 844c6f0c4f..8e466ab640 100755 --- a/tyk-docs/content/advanced-configuration/transform-traffic.md +++ b/tyk-docs/content/advanced-configuration/transform-traffic.md @@ -1,7 +1,7 @@ --- Title: Request and response middleware tags: ["middleware", "API request", "API response", "request processing", "response processing"] -description: "An overview of Tyk's customisable request and response processing chain" +description: "An overview of Tyk's customizable request and response processing chain" aliases: - /transform-traffic/endpoint-designer/ --- @@ -10,7 +10,7 @@ When you configure an API on Tyk, the Gateway will proxy all requests received a Within that chain are a highly configurable set of optional middleware that can, on a per-endpint basis: - apply processing to [API requests](#middleware-applied-to-the-api-request) before they are proxied to the upstream service -- apply customisation to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client +- apply customization to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client Tyk also supports a powerful custom plugin feature that enables you to add custom processing at different stages in the processing chains. For more details on custom plugins please see the [dedicated guide]({{< ref "plugins" >}}). diff --git a/tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md b/tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md index 8a66f080ee..fe09018344 100755 --- a/tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md +++ b/tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md @@ -19,7 +19,7 @@ There are related [Request Header Transform]({{< ref "transform-traffic/request- ## When to use response header transformation -#### Customising responses for specific clients +#### Customizing responses for specific clients A frequent use case for response header transformation is when a client requires specific headers for their application to function correctly. For example, a client may require a specific header to indicate the status of a request or to provide additional information about the response. diff --git a/tyk-docs/content/api-management/manage-apis/tyk-oas-api-definition/tyk-oas-middleware.md b/tyk-docs/content/api-management/manage-apis/tyk-oas-api-definition/tyk-oas-middleware.md index dd23ea4eee..4c615a7000 100644 --- a/tyk-docs/content/api-management/manage-apis/tyk-oas-api-definition/tyk-oas-middleware.md +++ b/tyk-docs/content/api-management/manage-apis/tyk-oas-api-definition/tyk-oas-middleware.md @@ -7,7 +7,7 @@ description: "Using middleware with Tyk OAS APIs" ### Introduction -Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customise the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs. +Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customize the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs. {{< note success >}} **Note** diff --git a/tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md b/tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md index 98789befa9..68998e8311 100755 --- a/tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md +++ b/tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md @@ -13,7 +13,7 @@ aliases: ## Set up an Event Webhook with an API Definition -In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customised) to be delivered to any open endpoint. +In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customized) to be delivered to any open endpoint. The webhook handler allows the configuration of the method, body, header values, and target URL and makes use of Go templates to expose the event metadata. diff --git a/tyk-docs/content/configure/outbound-email-configuration.md b/tyk-docs/content/configure/outbound-email-configuration.md index b4c4d3f9aa..22f169623a 100755 --- a/tyk-docs/content/configure/outbound-email-configuration.md +++ b/tyk-docs/content/configure/outbound-email-configuration.md @@ -101,16 +101,16 @@ If `SMTPUsername` or `SMTPPassword` is omitted, Tyk assumes that authentication "SecretAccessKey": "KEY" }, ``` -### Customise your Welcome Emails +### Customize your Welcome Emails -You can customise the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process. +You can customize the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process. {{< youtube XNyKRAlTDVs >}} 1. Select **Settings** from your **Dashboard** > **Portal Management** 2. You can change the from email address and the from email name for your welcome emails. -3. To use customised email content, select **Enable custom welcome email**. +3. To use customized email content, select **Enable custom welcome email**. 4. You can then add the following custom content: * Email Subject * Email Body content @@ -123,14 +123,14 @@ You can customise the welcome email that a developer recieves when they signup t 6. Click **Save** at the top of the Portal Settings screen. -### Customise your Key Approval Emails +### Customize your Key Approval Emails #### Editing the Email Body 1. Select **Settings** from your **Dashboard** > **Portal Management** 2. From the "API Key approval email" section, select "Enable custom approval email", and edit the API Key email body. -{{< img src="/img/2.10/key_approval_email_config.png" alt="Email-Customisation" >}} +{{< img src="/img/2.10/key_approval_email_config.png" alt="Email-Customization" >}} #### Add an image or logo to the Key Approval Email @@ -145,7 +145,7 @@ You can customise the welcome email that a developer recieves when they signup t The `LINK TO IMAGE` must be a publicly hosted resource. {{< /note >}} -In an Self-Managed installation you have full access to the HTML template, allowing you further customisation. +In an Self-Managed installation you have full access to the HTML template, allowing you further customization. #### Portal Manager Email Settings diff --git a/tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md b/tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md index ded19d525d..4a4a6548f4 100644 --- a/tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md +++ b/tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md @@ -9,6 +9,6 @@ weight: 0 Use case: What if your developer portal is not exactly what I need? -Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customise the portal's branding per organisation? +Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customize the portal's branding per organisation? We have the ability to configure the portal to suit your needs. For details, including a video tutorial, see [Create a Custom Developer Portal]({{< ref "tyk-developer-portal/tyk-portal-classic/customise/custom-developer-portal" >}}). diff --git a/tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md b/tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md index 0cf109d9c0..587f8c631d 100755 --- a/tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md +++ b/tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md @@ -13,4 +13,4 @@ The Multi-Cloud Redis container is ephemeral, it isn't configured for persistenc If using Redis with Multi-Cloud we strongly recommend using an external Redis database. -There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customise the configuration, but again, we don't recommend it. \ No newline at end of file +There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customize the configuration, but again, we don't recommend it. \ No newline at end of file diff --git a/tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md b/tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md index d7fcf52e1e..a54228b488 100755 --- a/tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md +++ b/tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md @@ -9,7 +9,7 @@ In any system, a task or operation takes a certain period of time to complete. W Tyk's Enforced Timeout middleware can be used to apply a maximum time that the Gateway will wait for a response before it terminates (or times out) the request. If the timeout expires, then Tyk will notify the client with an `HTTP 504 Gateway Timeout` error. -This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customised and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality. +This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customized and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality. ## When to use an enforced timeout diff --git a/tyk-docs/content/plugins/supported-languages.md b/tyk-docs/content/plugins/supported-languages.md index c4b9969a36..952561c0ba 100755 --- a/tyk-docs/content/plugins/supported-languages.md +++ b/tyk-docs/content/plugins/supported-languages.md @@ -78,7 +78,7 @@ The JavaScript Virtual Machine provides pluggable middleware that can modify a r * **TCP Access**: The JSVM has no socket access so working with DB drivers and directly with Redis is not possible. ### Rich Plugins -Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customised architecture to be built that integrates with a user's infrastructure. +Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customized architecture to be built that integrates with a user's infrastructure. Rich Plugins bring about the following improvements: diff --git a/tyk-docs/content/plugins/supported-languages/javascript-middleware.md b/tyk-docs/content/plugins/supported-languages/javascript-middleware.md index f1e0e27350..4de6b3d663 100755 --- a/tyk-docs/content/plugins/supported-languages/javascript-middleware.md +++ b/tyk-docs/content/plugins/supported-languages/javascript-middleware.md @@ -41,7 +41,7 @@ JavaScript functions are available globally in the same namespace. So, if you in The JavaScript Virtual Machine (JSVM) provided in the Gateway is a traditional ECMAScript5 compatible environment. -Before you can use JavaScript customisation in any component you will need to enable the JSVM. +Before you can use JavaScript customization in any component you will need to enable the JSVM. You do this by setting `enable_jsvm` to `true` in your `tyk.conf` [file]({{< ref "tyk-oss-gateway/configuration#enable_jsvm" >}}). diff --git a/tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md b/tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md index 25bf9d8772..cfb23953f1 100755 --- a/tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md +++ b/tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md @@ -15,7 +15,7 @@ aliases: - /plugins/javascript-middleware/middleware-scripting-guide --- -Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customisation and optimization of your request handling. +Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customization and optimization of your request handling. In this guide we will cover the features and resources available to you when creating custom functions, highlighting where there are limitations for the different middleware stages. diff --git a/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md b/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md index 243478fbea..1881520629 100644 --- a/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md +++ b/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md @@ -5,7 +5,7 @@ title: "Create Custom Authentication Plugin With Python" In the realm of API security, HMAC-signed authentication serves as a foundational concept. In this developer-focused blog post, we'll use HMAC-signed authentication as the basis for learning how to write gRPC custom authentication plugins with Tyk Gateway. Why learn how to write Custom Authentication Plugins? -- **Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customisation capabilities. +- **Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customization capabilities. - **Practical experience**: Gain hands-on experience in implementing custom authentication logic tailored to specific use cases, starting with HMAC-signed authentication. - **Enhanced control**: Exercise greater control over authentication flows and response handling, empowering developers to implement advanced authentication mechanisms beyond built-in features. @@ -655,7 +655,7 @@ While Tyk Gateway already supports HMAC-signed authentication out of the box, th It's important to note that the authentication mechanism implemented in this guide solely verifies the HMAC signature's validity and does not include access control checks against specific API resources. Developers should enhance this implementation by integrating access control logic to ensure authenticated requests have appropriate access permissions. -By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customise API authentication solutions according to their unique requirements. +By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customize API authentication solutions according to their unique requirements. --- diff --git a/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/request-transformation-java.md b/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/request-transformation-java.md index 1fccfd7bf5..457cf0675b 100644 --- a/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/request-transformation-java.md +++ b/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/request-transformation-java.md @@ -120,7 +120,7 @@ To generate the Protocol Buffers bindings we use the Gradle build task: gradle build ``` -If you need to customise any setting related to the bindings generation step, check the `build.gradle` file. +If you need to customize any setting related to the bindings generation step, check the `build.gradle` file. ### Implement Server diff --git a/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md b/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md index 98300c6b91..90b8edc7e9 100755 --- a/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md +++ b/tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md @@ -16,11 +16,11 @@ This document serves as a developer's guide for understanding the key concepts a This comprehensive guide covers essential tasks, including: -1. **Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customisation and tailored processing at each stage of the request lifecycle. +1. **Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customization and tailored processing at each stage of the request lifecycle. 2. **Configuring Tyk Gateway:** Set up Tyk Gateway to communicate with your gRPC Server and, optionally, an external secured web server hosting the gRPC plugin bundle for API configurations. Configure Tyk Gateway to fetch the bundle configured for an API from the web server, enabling seamless integration with gRPC plugins. Specify connection settings for streamlined integration. -3. **API Configuration:** Customise API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility. +3. **API Configuration:** Customize API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility. 4. **API Testing:** Test that Tyk Gateway integrates with your gRPC server for the plugins configured for your API. diff --git a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker-compose.md b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker-compose.md index 34ac8d5dc3..d7c6431de5 100644 --- a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker-compose.md +++ b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker-compose.md @@ -22,7 +22,7 @@ Additionally, all settings for the Portal are configured using an env-file. {{< warning success >}} **Note** -This document is just an example. Customise all fields, including the username, password, root password, database name and more. +This document is just an example. Customize all fields, including the username, password, root password, database name and more. {{< /warning >}} @@ -64,7 +64,7 @@ Once you have completed this step, you are ready to launch the portal applicatio ### Create a docker-compose file and launch the stack #### Create a docker-compose file -Before launching the portal using docker-compose, you will need to create a `docker-compose.yaml` file. An example of the portal's docker-compose file is provided below, which you can use as a starting point and further customise to meet your specific requirements. +Before launching the portal using docker-compose, you will need to create a `docker-compose.yaml` file. An example of the portal's docker-compose file is provided below, which you can use as a starting point and further customize to meet your specific requirements. Ensure that you replace `` with the specific version of the portal you intend to launch before executing the command, e.g. `tykio/portal:v1.7` for the portal v1.7. You can browse all available versions on [Docker Hub](https://hub.docker.com/r/tykio/portal/tags) and in the [release notes section]({{< ref "product-stack/tyk-enterprise-developer-portal/release-notes/portal-1.7.0.md" >}}). diff --git a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker.md b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker.md index ce9a56d101..0a0b5d18e6 100644 --- a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker.md +++ b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker.md @@ -18,7 +18,7 @@ Additionally, all settings for the Portal are configured using an env-file. {{< warning success >}} **Note** -This document is just an example. Customise all fields, including the username, password, root password, database name and more. +This document is just an example. Customize all fields, including the username, password, root password, database name and more. Be sure to update the connection DSN in the env-file accordingly. {{< /warning >}} @@ -71,7 +71,7 @@ postgres:10-alpine **Note** {{< warning success >}} -The above PostgreSQL configuration is an example. You can customise deployment of your PostgreSQL instance. Please refer to [the PostgreSQL documentation](https://www.postgresql.org/docs/current/installation.html) for further guidance. +The above PostgreSQL configuration is an example. You can customize deployment of your PostgreSQL instance. Please refer to [the PostgreSQL documentation](https://www.postgresql.org/docs/current/installation.html) for further guidance. {{< /warning >}} #### Create an environment variables file @@ -154,7 +154,7 @@ mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci - {{< warning success >}} **Note** -The above MySQL configuration is an example. You can customise deployment of your MySQL instance. +The above MySQL configuration is an example. You can customize deployment of your MySQL instance. Please refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html) for further guidance. {{< /warning >}} diff --git a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-rpm.md b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-rpm.md index 785b315cf7..488487760f 100644 --- a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-rpm.md +++ b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-rpm.md @@ -14,7 +14,7 @@ This guide provides a step-by-step recipe for launching the Tyk Enterprise Devel {{< warning success >}} **Note** -This document is just an example. Customise all fields, including the username, password, root password, database name and more. +This document is just an example. Customize all fields, including the username, password, root password, database name and more. Be sure to update the connection DSN in the env-file accordingly. {{< /warning >}} @@ -51,7 +51,7 @@ sudo rpm -i portal-1.7.0-1.x86_64.rpm Before starting the portal service, you need to configure the portal. Once the rpm package has been installed, the portal configuration file will be located in `/opt/portal/portal.conf`. Initially, the config file is filled with the default values. The minimal configuration change to start the portal is to add the `LicenseKey` property to the config file. The below sample configuration will start the portal on portal 3001 with SQLite as a database, no TLS enabled, and all CMS assets (images, theme files, etc.) are stored in the filesystem. -You can, however, customise the provided example and make more suitable for your need using the [configuration]({{< ref "product-stack/tyk-enterprise-developer-portal/deploy/configuration" >}}) reference. +You can, however, customize the provided example and make more suitable for your need using the [configuration]({{< ref "product-stack/tyk-enterprise-developer-portal/deploy/configuration" >}}) reference. ```json { "HostPort": 3001, diff --git a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/configure-webhooks.md b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/configure-webhooks.md index b3055dc197..a695f2fa3b 100644 --- a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/configure-webhooks.md +++ b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/configure-webhooks.md @@ -5,7 +5,7 @@ tags: ["Tyk Developer Portal","Enterprise Portal","Webhooks","Customization","In description: "Configure webhooks to react on events happening in the portal" menu: main: - parent: "Customise the portal" + parent: "Customize the portal" weight: 3 --- diff --git a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/customise-user-model.md b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/customise-user-model.md index c360b1db60..613d173772 100644 --- a/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/customise-user-model.md +++ b/tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/customise-user-model.md @@ -1,11 +1,11 @@ --- -title: "Customise the User model" +title: "Customize the User model" date: 2024-02-29 tags: ["Tyk Developer Portal","Enterprise Portal","Sign-up","User attributes","Metadata"] -description: "Customise the User model and extend the data stored in the User profile" +description: "Customize the User model and extend the data stored in the User profile" menu: main: - parent: "Customise the portal" + parent: "Customize the portal" weight: 3 --- @@ -18,8 +18,8 @@ If you are interested in getting access, contact us at [support@tyk.io](}} ## Add attributes to the user model diff --git a/tyk-docs/content/shared/create-portal-entry-include.md b/tyk-docs/content/shared/create-portal-entry-include.md index 220a8503a6..f628960f26 100644 --- a/tyk-docs/content/shared/create-portal-entry-include.md +++ b/tyk-docs/content/shared/create-portal-entry-include.md @@ -87,7 +87,7 @@ You can add your documentation before or after saving your API. We are not going to do anything with these options for this tutorial. For more information: * See [OAuth Clients]({{< ref "tyk-developer-portal/tyk-portal-classic/portal-oauth-clients" >}}) for details of using OAuth with your catalog entry. -* See [Portal Customisation]({{< ref "tyk-developer-portal/customise" >}})for details about redirection of key requests and developer signup customisation. +* See [Portal Customisation]({{< ref "tyk-developer-portal/customise" >}})for details about redirection of key requests and developer signup customization. ### Step 6: Save the API diff --git a/tyk-docs/content/shared/tyk-gateway-features-include.md b/tyk-docs/content/shared/tyk-gateway-features-include.md index 738dee9120..432196b397 100644 --- a/tyk-docs/content/shared/tyk-gateway-features-include.md +++ b/tyk-docs/content/shared/tyk-gateway-features-include.md @@ -22,7 +22,7 @@ Built from the ground up to be the fastest API gateway on the planet. It does no **Content mediation**: Transform all the things, from request or response headers to converting between SOAP and GraphQL. -**Extensible Plugin Architecture**: Customise Tyk’s middleware chain by writing plugins in your language of choice - from Javascript to Go, or any language which supports gRPC. +**Extensible Plugin Architecture**: Customize Tyk’s middleware chain by writing plugins in your language of choice - from Javascript to Go, or any language which supports gRPC. **Rate Limiting & Quotas:** Protect your upstreams from becoming overloaded and/or apply limits for each consumer. diff --git a/tyk-docs/content/tyk-cloud/configuration-options/using-plugins/setup-control-plane.md b/tyk-docs/content/tyk-cloud/configuration-options/using-plugins/setup-control-plane.md index ce99ed4634..b243b29402 100644 --- a/tyk-docs/content/tyk-cloud/configuration-options/using-plugins/setup-control-plane.md +++ b/tyk-docs/content/tyk-cloud/configuration-options/using-plugins/setup-control-plane.md @@ -13,7 +13,7 @@ aliases: ## Introduction -This page explains how to set up a control plane with plugins to customise it on Tyk Cloud, so that you can ensure your API management solution is as effective as possible. +This page explains how to set up a control plane with plugins to customize it on Tyk Cloud, so that you can ensure your API management solution is as effective as possible. ## What do I need to do to use Plugins? diff --git a/tyk-docs/content/tyk-cloud/initial-portal-config.md b/tyk-docs/content/tyk-cloud/initial-portal-config.md index 89c8cf5175..52a6ea7e66 100644 --- a/tyk-docs/content/tyk-cloud/initial-portal-config.md +++ b/tyk-docs/content/tyk-cloud/initial-portal-config.md @@ -37,4 +37,4 @@ You should now be able to access your Portal from **Open Your Portal** from the ## Further Portal Configuration -Our Developer Portal is completely customisable. See [Portal Customisation]({{< ref "tyk-developer-portal/customise" >}}) for more details. \ No newline at end of file +Our Developer Portal is completely customisable. See [Portal Customization]({{< ref "tyk-developer-portal/customise" >}}) for more details. \ No newline at end of file diff --git a/tyk-docs/content/tyk-dashboard.md b/tyk-docs/content/tyk-dashboard.md index e7e52fd1cf..05ee64324c 100755 --- a/tyk-docs/content/tyk-dashboard.md +++ b/tyk-docs/content/tyk-dashboard.md @@ -13,7 +13,7 @@ aliases: The Tyk Dashboard is the GUI and analytics platform for Tyk. It provides an easy-to-use management interface for managing a Tyk installation as well as clear and granular analytics. -The Dashboard also provides the [API Developer Portal]({{< ref "/content/tyk-developer-portal.md" >}}), a customisable developer portal for your API documentation, developer auto-enrollment and usage tracking. +The Dashboard also provides the [API Developer Portal]({{< ref "/content/tyk-developer-portal.md" >}}), a customizable developer portal for your API documentation, developer auto-enrollment and usage tracking. The Dashboard also exposes the Developer Portal as a separate component of the application. This means it can either be deployed as an internet-facing application or as a purely admin application depending on how it is being used: diff --git a/tyk-docs/content/tyk-developer-portal.md b/tyk-docs/content/tyk-developer-portal.md index c450904eb3..546adaa5ea 100755 --- a/tyk-docs/content/tyk-developer-portal.md +++ b/tyk-docs/content/tyk-developer-portal.md @@ -16,7 +16,7 @@ The Tyk Developer Portal comes into two flavors: * Tyk Classic Developer Portal. * Tyk Enterprise Developer Portal. -The Tyk Classic Developer Portal is relevant for the primary use-cases while the Tyk Enterprise Developer Portal is suitable for more advanced use cases such audience management, developer relatationship and deep look & feel customisation. +The Tyk Classic Developer Portal is relevant for the primary use-cases while the Tyk Enterprise Developer Portal is suitable for more advanced use cases such audience management, developer relatationship and deep look & feel customization. {{< note success >}} **Tyk Enterprise Developer Portal** diff --git a/tyk-docs/content/tyk-on-premises.md b/tyk-docs/content/tyk-on-premises.md index 6041dd5b05..7cd62c36e4 100755 --- a/tyk-docs/content/tyk-on-premises.md +++ b/tyk-docs/content/tyk-on-premises.md @@ -22,7 +22,7 @@ Tyk Self-Managed allows you to easily install our Full Lifecycle API Management The full Tyk Self-Managed system consists of: * [Tyk Gateway]({{< ref "tyk-oss-gateway" >}}): Tyk Gateway is provided ‘Batteries-included’, with no feature lockout. It is an open source enterprise API Gateway, supporting REST, GraphQL, TCP and gRPC protocols, that protects, secures and processes your APIs. -* [Tyk Dashboard]({{< ref "tyk-dashboard" >}}): The management Dashboard and integration API manage a cluster of Tyk Gateways and also show analytics and features of the [Developer portal]({{< ref "tyk-developer-portal" >}}). The Dashboard also provides the API Developer Portal, a customisable developer portal for your API documentation, developer auto-enrollment and usage tracking. +* [Tyk Dashboard]({{< ref "tyk-dashboard" >}}): The management Dashboard and integration API manage a cluster of Tyk Gateways and also show analytics and features of the [Developer portal]({{< ref "tyk-developer-portal" >}}). The Dashboard also provides the API Developer Portal, a customizable developer portal for your API documentation, developer auto-enrollment and usage tracking. * [Tyk Pump]({{< ref "tyk-pump" >}}): Tyk Pump handles moving analytics data between your gateways and your Dashboard (amongst other data sinks). The Tyk Pump is an open source analytics purger that moves the data generated by your Tyk nodes to any back-end. * [Tyk Identity Broker]({{< ref "tyk-identity-broker" >}}) (Optional): Tyk Identify Broker handles integrations with third-party IDP's. It (TIB) is a component providing a bridge between various Identity Management Systems such as LDAP, Social OAuth (e.g. GPlus, Twitter, GitHub) or Basic Authentication providers, to your Tyk installation. * [Tyk Multi-Data Center Bridge]({{< ref "tyk-multi-data-centre" >}}) (Optional, add-on): Tyk Multi-Data Center Bridge allows for the configuration of a Tyk ecosystem that spans many data centers and clouds. It also (MDCB) acts as a broker between Tyk Gateway Instances that are isolated from one another and typically have their own Redis DB. diff --git a/tyk-docs/content/tyk-on-premises/installation/on-heroku.md b/tyk-docs/content/tyk-on-premises/installation/on-heroku.md index f986b5a6f3..f2969ea592 100644 --- a/tyk-docs/content/tyk-on-premises/installation/on-heroku.md +++ b/tyk-docs/content/tyk-on-premises/installation/on-heroku.md @@ -15,7 +15,7 @@ aliases: ## Install Tyk API Gateway on Heroku -A full Tyk Self-Managed installation can be deployed to Heroku dynos and workers using [Heroku Container Registry and Runtime](https://devcenter.heroku.com/articles/) functionality. This guide will utilize [Tyk Docker images](https://hub.docker.com/u/tykio/) with a small amount of customisation as well as an external MongoDB service. +A full Tyk Self-Managed installation can be deployed to Heroku dynos and workers using [Heroku Container Registry and Runtime](https://devcenter.heroku.com/articles/) functionality. This guide will utilize [Tyk Docker images](https://hub.docker.com/u/tykio/) with a small amount of customization as well as an external MongoDB service. ## Prerequisites @@ -426,7 +426,7 @@ After re-starting the Gateway, the logs should be showing something similar to t Set this variable back to an empty value in order to revert back to the default behavior. -## Upgrading or Customising Tyk +## Upgrading or Customizing Tyk Since this deployment is based on Docker images and containers, upgrading or making changes to the deployment is as easy as building a new image and pushing it to the registry. diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/customise-enterprise-portal.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/customise-enterprise-portal.md index 5c78111967..6586deba1b 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/customise-enterprise-portal.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/customise-enterprise-portal.md @@ -1,5 +1,5 @@ --- -title: "Customise the Enterprise Portal" +title: "Customize the Enterprise Portal" date: 2022-02-08 tags: [""] description: "" diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/content-manager-workflow.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/content-manager-workflow.md index 7383e38b50..93a616e479 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/content-manager-workflow.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/content-manager-workflow.md @@ -5,7 +5,7 @@ tags: [""] description: "" menu: main: - parent: "Full Customisation" + parent: "Full Customization" weight: 2 --- {{< note success >}} diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/developer-workflow.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/developer-workflow.md index 97b3d8d631..e17f7e1c0f 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/developer-workflow.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/developer-workflow.md @@ -5,7 +5,7 @@ tags: [""] description: "" menu: main: - parent: "Full Customisation" + parent: "Full Customization" weight: 1 --- {{< note success >}} @@ -15,11 +15,11 @@ If you are interested in getting access contact us at [support@tyk.io](}} -The Tyk Enterprise Developer Portal uses themes for customising the live portal. We provide an out of the box theme that is using our own branding, it’s called the ‘default’ theme. You are welcome to use it and modify it for your needs, yet if you want to start with a blank page, you can also create a completely new theme. +The Tyk Enterprise Developer Portal uses themes for customizing the live portal. We provide an out of the box theme that is using our own branding, it’s called the ‘default’ theme. You are welcome to use it and modify it for your needs, yet if you want to start with a blank page, you can also create a completely new theme. -This section provides a complete guide to full customisation from the developer's point of view. +This section provides a complete guide to full customization from the developer's point of view. ## Introduction -For organisations with developers customising pages layout and other technical aspects of the portal pages, we are recommending the following workflow. +For organisations with developers customizing pages layout and other technical aspects of the portal pages, we are recommending the following workflow. {{< img src="/img/dashboard/portal-management/enterprise-portal/portal-fe-develop-flow.png" alt="Developer workflow" >}} \ No newline at end of file diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/email-customization.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/email-customization.md index 2366138278..0c9c3cf8bd 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/email-customization.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/email-customization.md @@ -5,7 +5,7 @@ tags: [""] description: "" menu: main: - parent: "Full Customisation" + parent: "Full Customization" weight: 1 --- {{< note success >}} @@ -15,10 +15,10 @@ If you are interested in getting access, contact us at [support@tyk.io](}} -The Tyk Enterprise Developer Portal enables admin users to customise emails that are sent to the API consumers and admin users upon certain events that happen on the portal. -As an admin user, you can fully customise emails that are sent from the portal. +The Tyk Enterprise Developer Portal enables admin users to customize emails that are sent to the API consumers and admin users upon certain events that happen on the portal. +As an admin user, you can fully customize emails that are sent from the portal. -This section provides a guide to email customisation. +This section provides a guide to email customization. ## List of email notifications diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md index 57e8f275d5..e6d3d17143 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md @@ -18,7 +18,7 @@ If you are interested in getting access, contact us at [support@tyk.io](}} -This section covers all aspects of complete customisation of the Tyk Enterprise developer portal from both developer and content manager points of view. \ No newline at end of file +This section covers all aspects of complete customization of the Tyk Enterprise developer portal from both developer and content manager points of view. \ No newline at end of file diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md index 1cd5789209..a7b11bdb25 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md @@ -1,5 +1,5 @@ --- -title: "Menus Customisation" +title: "Menus Customization" date: 2022-02-09 tags: [""] description: "" diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/quick-customisation.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/quick-customisation.md index 1c3a165772..dd8ccf4d08 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/quick-customisation.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/quick-customisation.md @@ -1,11 +1,11 @@ --- -title: "Quick Customisation" +title: "Quick Customization" date: 2022-02-08 tags: [""] description: "" menu: main: - parent: "Customise the Enterprise Portal" + parent: "Customize the Enterprise Portal" weight: 1 --- diff --git a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/customise-menus.md b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/customise-menus.md index cd50fff59d..c0e9841d5f 100644 --- a/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/customise-menus.md +++ b/tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/customise-menus.md @@ -1,5 +1,5 @@ --- -title: "Customise the menu of live portal" +title: "Customize the menu of live portal" date: 2022-02-08 tags: [""] description: "" @@ -18,7 +18,7 @@ If you are interested in getting access, contact us at [support@tyk.io](}} Each menu item may: @@ -27,7 +27,7 @@ Each menu item may: - show a dropdown list with possible navigational options: {{< img src="img/dashboard/portal-management/enterprise-portal/dropdown-menu-item.png" alt="Dropdown menu item" >}} -Admin users can create additional navigational menus and render them on any page of the live portal. This customisation requires changes to a theme and is covered in the [Full customisation section]({{< ref "/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md" >}}). +Admin users can create additional navigational menus and render them on any page of the live portal. This customization requires changes to a theme and is covered in the [Full customization section]({{< ref "/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md" >}}). ## Manage menu items diff --git a/tyk-docs/content/tyk-stack/tyk-pump/other-data-stores/monitor-apis-prometheus.md b/tyk-docs/content/tyk-stack/tyk-pump/other-data-stores/monitor-apis-prometheus.md index ce46258631..fe161fd38c 100644 --- a/tyk-docs/content/tyk-stack/tyk-pump/other-data-stores/monitor-apis-prometheus.md +++ b/tyk-docs/content/tyk-stack/tyk-pump/other-data-stores/monitor-apis-prometheus.md @@ -130,7 +130,7 @@ scrape_configs: ### Exploring your metrics in Grafana -Before trying out, make sure to generate traffic by calling your APIs. You will find a [couple of useful queries](https://github.com/TykTechnologies/tyk-pump#prometheus) in our Tyk Pump GitHub repo based on the metrics exposed by Tyk. These will demonstrate which metric types are exported and how you can customise them. +Before trying out, make sure to generate traffic by calling your APIs. You will find a [couple of useful queries](https://github.com/TykTechnologies/tyk-pump#prometheus) in our Tyk Pump GitHub repo based on the metrics exposed by Tyk. These will demonstrate which metric types are exported and how you can customize them. You also need to make sure that Grafana is connected to your Prometheus server. This can be configured under [Configuration / Data sources](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) diff --git a/tyk-docs/content/upgrading-tyk.md b/tyk-docs/content/upgrading-tyk.md index faf867b896..f2be048ef2 100644 --- a/tyk-docs/content/upgrading-tyk.md +++ b/tyk-docs/content/upgrading-tyk.md @@ -19,7 +19,7 @@ These considerations are reflected in our structured upgrade guides, ensuring yo Our upgrade process adheres to the following standards: - **Breaking changes:** Breaking changes are rare and will be explicitly stated in the release notes. -- **Configuration files:** Upgrades do not overwrite your configuration files. However, it’s good practice to routinely back up these files (using git or another tool) before upgrading, so any customisations are saved. +- **Configuration files:** Upgrades do not overwrite your configuration files. However, it’s good practice to routinely back up these files (using git or another tool) before upgrading, so any customizations are saved. - **Migration scripts:** Migration scripts for your APIs, policies, or other assets are generally not required unless specified in the release notes. - **Long Term Support:** Refer to our [versioning and long-term support policies]({{< ref "developer-support/special-releases-and-features/long-term-support-releases" >}}) for details on major and minor releases, patches, and support dates. - **Preparations:** Review the [preparation guidelines]({{< ref "developer-support/upgrading-tyk/preparations/upgrade-guidelines" >}}) before starting the upgrade.