You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
-**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.+**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.
Suggestion importance[1-10]: 8
Why: Using consistent capitalization for programming languages enhances the professional appearance of the documentation. This is a good practice for maintaining a polished and standardized style.
8
Combine and streamline sentences for better flow and conciseness
Combine sentences to streamline the text and improve flow.
-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.+The Tyk Enterprise Developer Portal enables admin users to fully customize emails that are sent to API consumers and other admin users in response to certain events on the portal.
Suggestion importance[1-10]: 8
Why: Combining sentences to streamline the text improves the flow and conciseness of the documentation. This enhances readability and makes the information easier to digest.
8
Refine the description to specify the nature of customizations
Consider using a more specific term than "customizable" to describe the request and response processing chain. This could help clarify the types of customizations available to users.
-description: "An overview of Tyk's customizable request and response processing chain"+description: "An overview of Tyk's flexible request and response processing chain, supporting a wide range of modifications and extensions"
Suggestion importance[1-10]: 7
Why: The suggestion improves clarity by specifying the types of customizations available, making the description more informative and engaging for users.
7
Expand the description of Rich Plugins to include specific examples of capabilities
The description of Rich Plugins could be expanded to include examples of what "full-blown, optimized, highly capable services" might entail, providing clearer expectations for the user.
-Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services.+Rich Plugins can replace existing middleware functions, offering comprehensive, optimized, and powerful services such as advanced data processing and enhanced API security features.
Suggestion importance[1-10]: 7
Why: Providing specific examples of what Rich Plugins can do helps set clearer expectations and gives users a better understanding of their capabilities.
7
Make the instruction more direct and engaging
The phrase "customize the welcome email" could be made more active to engage the reader better. Consider rephrasing for clarity and action-orientation.
-You can customize the welcome email that a developer recieves when they signup to your portal.+Customize the welcome email to enhance developer engagement when they sign up for your portal.
Suggestion importance[1-10]: 6
Why: The rephrased instruction is more action-oriented and engaging, which can help in better user engagement and understanding.
6
Maintainability
Adjust the heading level for better document structure
The heading level for "Customizing responses for specific clients" seems inconsistent with the surrounding content structure. Consider adjusting the heading level to maintain a logical and hierarchical flow in the document.
-* See [Portal Customisation]({{< ref "tyk-developer-portal/customise" >}})for details about redirection of key requests and developer signup customization.+* See [Portal Customisation]({{< ref "tyk-developer-portal/customise" >}}) for details about redirection of key requests and developer signup customization.
Suggestion importance[1-10]: 7
Why: Adding a space after the link reference improves readability and maintains consistency in markdown files. This is a minor but useful enhancement for documentation clarity.
7
Improve the clarity and readability of the sentence
Clarify the sentence structure to enhance understanding and readability.
-For organisations with developers customizing pages layout and other technical aspects of the portal pages, we are recommending the following workflow.+For organisations with developers who are customizing the layout and other technical aspects of portal pages, we recommend the following workflow.
Suggestion importance[1-10]: 7
Why: The suggested change clarifies the sentence structure, making it easier to understand and improving overall readability. This is a minor but beneficial improvement for documentation quality.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
DX-1437 customise --> customize (PR 1) (#5059)
customise 1
PR Type
Documentation
Description
Changes walkthrough 📝
38 files
transform-traffic.md
Standardized spelling to "customizable" in transform-traffic.md
tyk-docs/content/advanced-configuration/transform-traffic.md
text.
response-headers.md
Standardized spelling to "Customizing" in response-headers.md
tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md
tyk-oas-middleware.md
Standardized spelling to "customize" in tyk-oas-middleware.md
tyk-docs/content/api-management/manage-apis/tyk-oas-api-definition/tyk-oas-middleware.md
webhooks.md
Standardized spelling to "customized" in webhooks.md
tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md
outbound-email-configuration.md
Standardized spelling to "customize" in
outbound-email-configuration.md
tyk-docs/content/configure/outbound-email-configuration.md
body text.
custom-developer-portal-options.md
Standardized spelling to "customize" in
custom-developer-portal-options.md
tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md
redis-persistence-using-containers.md
Standardized spelling to "customize" in
redis-persistence-using-containers.md
tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md
enforced-timeouts.md
Standardized spelling to "customized" in enforced-timeouts.md
tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md
supported-languages.md
Standardized spelling to "customized" in supported-languages.md
tyk-docs/content/plugins/supported-languages.md
javascript-middleware.md
Standardized spelling to "customization" in javascript-middleware.md
tyk-docs/content/plugins/supported-languages/javascript-middleware.md
middleware-scripting-guide.md
Standardized spelling to "customization" in
middleware-scripting-guide.md
tyk-docs/content/plugins/supported-languages/javascript-middleware/middleware-scripting-guide.md
custom-auth-python.md
Standardized spelling to "customization" in custom-auth-python.md
tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/custom-auth-python.md
request-transformation-java.md
Standardized spelling to "customize" in request-transformation-java.md
tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/request-transformation-java.md
write-grpc-plugin.md
Standardized spelling to "customization" in write-grpc-plugin.md
tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md
install-portal-using-docker-compose.md
Standardized spelling to "customize" in
install-portal-using-docker-compose.md
tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker-compose.md
install-portal-using-docker.md
Standardized spelling to "customize" in install-portal-using-docker.md
tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker.md
install-portal-using-rpm.md
Standardized spelling to "customize" in install-portal-using-rpm.md
tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-rpm.md
configure-webhooks.md
Standardized spelling to "Customize" in configure-webhooks.md
tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/configure-webhooks.md
customise-user-model.md
Standardized spelling to "Customize" in customise-user-model.md
tyk-docs/content/product-stack/tyk-enterprise-developer-portal/portal-customisation/customise-user-model.md
create-portal-entry-include.md
Standardized spelling to "customization" in
create-portal-entry-include.md
tyk-docs/content/shared/create-portal-entry-include.md
tyk-gateway-features-include.md
Standardized spelling to "customize" in
tyk-gateway-features-include.md
tyk-docs/content/shared/tyk-gateway-features-include.md
setup-control-plane.md
Standardized spelling to "customize" in setup-control-plane.md
tyk-docs/content/tyk-cloud/configuration-options/using-plugins/setup-control-plane.md
initial-portal-config.md
Standardized spelling to "customizable" in initial-portal-config.md
tyk-docs/content/tyk-cloud/initial-portal-config.md
tyk-dashboard.md
Standardized spelling to "customizable" in tyk-dashboard.md
tyk-docs/content/tyk-dashboard.md
tyk-developer-portal.md
Standardized spelling to "customization" in tyk-developer-portal.md
tyk-docs/content/tyk-developer-portal.md
tyk-on-premises.md
Standardized spelling to "customizable" in tyk-on-premises.md
tyk-docs/content/tyk-on-premises.md
on-heroku.md
Standardized spelling to "customization" in on-heroku.md
tyk-docs/content/tyk-on-premises/installation/on-heroku.md
customise-enterprise-portal.md
Standardized spelling to "Customize" in customise-enterprise-portal.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/customise-enterprise-portal.md
content-manager-workflow.md
Standardized spelling to "Customization" in
content-manager-workflow.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/content-manager-workflow.md
developer-workflow.md
Standardized spelling to "Customization" in developer-workflow.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/developer-workflow.md
text.
email-customization.md
Standardized spelling to "Customization" in email-customization.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/email-customization.md
text.
file-structure-concepts.md
Standardized spelling to "customizing" in file-structure-concepts.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md
full-customisation.md
Standardized spelling to "Customization" in full-customisation.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/full-customisation.md
menus-customisation.md
Standardized spelling to "Customization" in menus-customisation.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/menus-customisation.md
quick-customisation.md
Standardized spelling to "Customization" in quick-customisation.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/quick-customisation.md
customise-menus.md
Standardized spelling to "Customize" in customise-menus.md
tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/customise-menus.md
monitor-apis-prometheus.md
Standardized spelling to "customize" in monitor-apis-prometheus.md
tyk-docs/content/tyk-stack/tyk-pump/other-data-stores/monitor-apis-prometheus.md
upgrading-tyk.md
Standardized spelling to "customizations" in upgrading-tyk.md
tyk-docs/content/upgrading-tyk.md