Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merging to release-5.4: [DX-1437] customise --> customize (PR 1) (#5059) #5060

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jul 11, 2024

User description

DX-1437 customise --> customize (PR 1) (#5059)

customise 1


PR Type

Documentation


Description

  • Standardized the spelling of "customise" to "customize" across multiple documentation files.
  • Updated section headers, titles, and body text to ensure consistency in spelling.
  • Affected files include various Markdown documents related to Tyk's advanced configuration, API management, plugins, product stack, and more.

Changes walkthrough 📝

Relevant files
Documentation
38 files
transform-traffic.md
Standardized spelling to "customizable" in transform-traffic.md

tyk-docs/content/advanced-configuration/transform-traffic.md

  • Changed "customisable" to "customizable" in the description and body
    text.
  • +2/-2     
    response-headers.md
    Standardized spelling to "Customizing" in response-headers.md

    tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md

    • Changed "Customising" to "Customizing" in a section header.
    +1/-1     
    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

    • Changed "customise" to "customize" in the introduction section.
    +1/-1     
    webhooks.md
    Standardized spelling to "customized" in webhooks.md         

    tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md

    • Changed "customised" to "customized" in the setup instructions.
    +1/-1     
    outbound-email-configuration.md
    Standardized spelling to "customize" in
    outbound-email-configuration.md

    tyk-docs/content/configure/outbound-email-configuration.md

  • Changed "customise" to "customize" in multiple section headers and
    body text.
  • +6/-6     
    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

    • Changed "customise" to "customize" in the body text.
    +1/-1     
    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

    • Changed "customise" to "customize" in the body text.
    +1/-1     
    enforced-timeouts.md
    Standardized spelling to "customized" in enforced-timeouts.md

    tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md

    • Changed "customised" to "customized" in the body text.
    +1/-1     
    supported-languages.md
    Standardized spelling to "customized" in supported-languages.md

    tyk-docs/content/plugins/supported-languages.md

    • Changed "customised" to "customized" in the body text.
    +1/-1     
    javascript-middleware.md
    Standardized spelling to "customization" in javascript-middleware.md

    tyk-docs/content/plugins/supported-languages/javascript-middleware.md

    • Changed "customisation" to "customization" in the body text.
    +1/-1     
    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

    • Changed "customisation" to "customization" in the body text.
    +1/-1     
    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

    • Changed "customisation" to "customization" in the body text.
    +2/-2     
    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

    • Changed "customise" to "customize" in the body text.
    +1/-1     
    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

    • Changed "customisation" to "customization" in the body text.
    +2/-2     
    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

    • Changed "customise" to "customize" in the body text.
    +2/-2     
    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

    • Changed "customise" to "customize" in the body text.
    +3/-3     
    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

    • Changed "customise" to "customize" in the body text.
    +2/-2     
    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

    • Changed "Customise" to "Customize" in the title and body text.
    +1/-1     
    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

    • Changed "Customise" to "Customize" in the title and body text.
    +6/-6     
    create-portal-entry-include.md
    Standardized spelling to "customization" in
    create-portal-entry-include.md

    tyk-docs/content/shared/create-portal-entry-include.md

    • Changed "customisation" to "customization" in the body text.
    +1/-1     
    tyk-gateway-features-include.md
    Standardized spelling to "customize" in
    tyk-gateway-features-include.md

    tyk-docs/content/shared/tyk-gateway-features-include.md

    • Changed "customise" to "customize" in the body text.
    +1/-1     
    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

    • Changed "customise" to "customize" in the body text.
    +1/-1     
    initial-portal-config.md
    Standardized spelling to "customizable" in initial-portal-config.md

    tyk-docs/content/tyk-cloud/initial-portal-config.md

    • Changed "customisable" to "customizable" in the body text.
    +1/-1     
    tyk-dashboard.md
    Standardized spelling to "customizable" in tyk-dashboard.md

    tyk-docs/content/tyk-dashboard.md

    • Changed "customisable" to "customizable" in the body text.
    +1/-1     
    tyk-developer-portal.md
    Standardized spelling to "customization" in tyk-developer-portal.md

    tyk-docs/content/tyk-developer-portal.md

    • Changed "customisation" to "customization" in the body text.
    +1/-1     
    tyk-on-premises.md
    Standardized spelling to "customizable" in tyk-on-premises.md

    tyk-docs/content/tyk-on-premises.md

    • Changed "customisable" to "customizable" in the body text.
    +1/-1     
    on-heroku.md
    Standardized spelling to "customization" in on-heroku.md 

    tyk-docs/content/tyk-on-premises/installation/on-heroku.md

    • Changed "customisation" to "customization" in the body text.
    +2/-2     
    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

    • Changed "Customise" to "Customize" in the title.
    +1/-1     
    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

    • Changed "Customisation" to "Customization" in the parent menu.
    +1/-1     
    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

  • Changed "Customisation" to "Customization" in the parent menu and body
    text.
  • +4/-4     
    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

  • Changed "Customisation" to "Customization" in the parent menu and body
    text.
  • +4/-4     
    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

    • Changed "customising" to "customizing" in the body text.
    +1/-1     
    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

  • Changed "Customisation" to "Customization" in the title and body text.

  • +3/-3     
    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

    • Changed "Customisation" to "Customization" in the title.
    +1/-1     
    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

    • Changed "Customisation" to "Customization" in the title.
    +2/-2     
    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

    • Changed "Customise" to "Customize" in the title and body text.
    +3/-3     
    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

    • Changed "customise" to "customize" in the body text.
    +1/-1     
    upgrading-tyk.md
    Standardized spelling to "customizations" in upgrading-tyk.md

    tyk-docs/content/upgrading-tyk.md

    • Changed "customisations" to "customizations" in the body text.
    +1/-1     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    customise 1
    
    (cherry picked from commit 6f22538)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link

    netlify bot commented Jul 11, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 85f6c08
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/668fe3183a55910008159bb3
    😎 Deploy Preview https://deploy-preview-5060--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @buger buger merged commit 3f7cfe2 into release-5.4 Jul 11, 2024
    10 checks passed
    @buger buger deleted the merge/release-5.4/6f225380641a9418631712c47bd546d09ebb6034 branch July 11, 2024 13:52
    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Standardize capitalization of programming language names

    Use consistent capitalization for programming languages to enhance the professional
    appearance of the documentation.

    tyk-docs/content/shared/tyk-gateway-features-include.md [25]

    -**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.

    tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/email-customization.md [18-19]

    -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.

    tyk-docs/content/advanced-configuration/transform-traffic.md [4]

    -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.

    tyk-docs/content/plugins/supported-languages.md [81]

    -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.

    tyk-docs/content/configure/outbound-email-configuration.md [106]

    -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.

    tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md [22]

    -#### Customizing responses for specific clients
    +### Customizing responses for specific clients
     
    Suggestion importance[1-10]: 8

    Why: Adjusting the heading level enhances the document's readability and logical flow, making it easier for users to navigate the content.

    8
    Improve readability by adding a space after the markdown link reference

    Add a space after the link reference to maintain consistency and improve readability
    in markdown files.

    tyk-docs/content/shared/create-portal-entry-include.md [90]

    -* 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.

    tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/developer-workflow.md [23]

    -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.

    7

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants