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] organise --> organize (PR 1) (#5065) #5076

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jul 12, 2024

User description

DX-1437 organise --> organize (PR 1) (#5065)

  • organise 1

  • organise fix 1

  • revert email-customization.md changes


PR Type

documentation


Description

  • Corrected spelling from "organisation" to "organization" across multiple documentation files.
  • Ensured consistency in terminology throughout the documentation.

Changes walkthrough 📝

Relevant files
Documentation
28 files
basic-config-and-security.md
Correct spelling in basic configuration and security documentation

tyk-docs/content/basic-config-and-security.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
api-def-common.md
Correct spelling in API definition common documentation   

tyk-docs/content/shared/api-def-common.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
create-api-include.md
Correct spelling in create API include documentation         

tyk-docs/content/shared/create-api-include.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
tyk-gateway-features-include.md
Correct spelling in Tyk gateway features documentation     

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

  • Corrected spelling from "organisation" to "organization".
+2/-2     
tyk-cloud.md
Correct spelling in Tyk Cloud documentation                           

tyk-docs/content/tyk-cloud.md

  • Corrected spelling from "organisation" to "organization".
+2/-2     
ansible.md
Correct spelling in Ansible documentation                               

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

  • Corrected spelling from "organisation" to "organization".
+1/-1     
bootstrapper-cli.md
Correct spelling in Bootstrapper CLI documentation             

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

  • Corrected spelling from "organisation" to "organization".
+2/-2     
debian-ubuntu.md
Correct spelling in Debian/Ubuntu documentation                   

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

  • Corrected spelling from "organisation" to "organization".
+1/-1     
dashboard.md
Correct spelling in Debian/Ubuntu Dashboard documentation

tyk-docs/content/tyk-on-premises/debian-ubuntu/dashboard.md

  • Corrected spelling from "organisation" to "organization".
+4/-4     
gateway.md
Correct spelling in Debian/Ubuntu Gateway documentation   

tyk-docs/content/tyk-on-premises/debian-ubuntu/gateway.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
docker-pro-demo.md
Correct spelling in Docker Pro Demo documentation               

tyk-docs/content/tyk-on-premises/docker/docker-pro-demo.md

  • Corrected spelling from "organisation" to "organization".
+4/-4     
docker-pro-demo-windows.md
Correct spelling in Docker Pro Demo Windows documentation

tyk-docs/content/tyk-on-premises/docker/docker-pro-demo/docker-pro-demo-windows.md

  • Corrected spelling from "organisation" to "organization".
+3/-3     
docker-pro-wsl.md
Correct spelling in Docker Pro Demo WSL documentation       

tyk-docs/content/tyk-on-premises/docker/docker-pro-demo/docker-pro-wsl.md

  • Corrected spelling from "organisation" to "organization".
+3/-3     
on-heroku.md
Correct spelling in Heroku installation documentation       

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

  • Corrected spelling from "organisation" to "organization".
+2/-2     
licensing.md
Correct spelling in licensing documentation                           

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

  • Corrected spelling from "organisation" to "organization".
+1/-1     
redhat-rhel-centos.md
Correct spelling in RedHat/RHEL/CentOS documentation         

tyk-docs/content/tyk-on-premises/redhat-rhel-centos.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
configuring-custom-rate-limit-keys.md
Correct spelling in configuring custom rate limit keys documentation

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/configuring-custom-rate-limit-keys.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
content-manager-workflow.md
Correct spelling in content manager workflow documentation

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/content-manager-workflow.md

  • Corrected spelling from "organise" to "organize".
+2/-2     
developer-workflow.md
Correct spelling in developer workflow documentation         

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

  • Corrected spelling from "organisations" to "organizations".
+1/-1     
file-structure-concepts.md
Correct spelling in file structure concepts documentation

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md

  • Corrected spelling from "organise" to "organize".
+1/-1     
publish-api-products-and-plans.md
Correct spelling in publish API products and plans documentation

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/publish-api-products-and-plans.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
with-tyk-self-managed-as-provider.md
Correct spelling in Tyk self-managed provider documentation

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/with-tyk-self-managed-as-provider.md

  • Corrected spelling from "organisation" to "organization".
+3/-3     
add-organisations.md
Correct spelling in add organizations documentation           

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/add-organisations.md

  • Corrected spelling from "organisation" to "organization".
+6/-6     
enable-sso.md
Correct spelling in enable SSO documentation                         

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/enable-sso.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
manage-api-consumer-organisations.md
Correct spelling in manage API consumer organizations documentation

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumer-organisations.md

  • Corrected spelling from "organisation" to "organization".
+27/-27 
capping-analytics-data-storage.md
Correct spelling in capping analytics data storage documentation

tyk-docs/content/tyk-stack/tyk-manager/analytics/capping-analytics-data-storage.md

  • Corrected spelling from "organisation" to "organization".
+3/-3     
installing-tyk-operator.md
Correct spelling in installing Tyk operator documentation

tyk-docs/content/tyk-stack/tyk-operator/installing-tyk-operator.md

  • Corrected spelling from "organisation" to "organization".
+1/-1     
tyk-analytics-record-fields.md
Correct spelling in Tyk analytics record fields documentation

tyk-docs/content/tyk-stack/tyk-pump/tyk-analytics-record-fields.md

  • Corrected spelling from "organisation" to "organization".
+2/-2     

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

* organise 1

* organise fix 1

* revert email-customization.md changes

(cherry picked from commit c7ed6cd)
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 12, 2024

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

Name Link
🔨 Latest commit dea4be6
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/669166f39856450008fd2612
😎 Deploy Preview https://deploy-preview-5076--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 1c83f4d into release-5.4 Jul 12, 2024
10 checks passed
@buger buger deleted the merge/release-5.4/c7ed6cd2ba5c7771da9dc5acaf1d64ad92ddb049 branch July 12, 2024 17:27
Copy link
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Enhancement
Improve grammatical consistency and clarity in the description of event monitoring

Consider revising the phrasing "This section also cover the use of monitors for user
and organization quotas" to ensure grammatical consistency and clarity.

tyk-docs/content/basic-config-and-security.md [18]

-- [Report, monitor and trigger events]({{< ref "basic-config-and-security/report-monitor-trigger-events" >}}). This section describes what event data you can include in your APIs, and how you can do manage them with the use of webhooks and custom JavaScript handlers. This section also cover the use of monitors for user and organization quotas, as well as StatsD and NewRelic instrumentation.
+- [Report, monitor and trigger events]({{< ref "basic-config-and-security/report-monitor-trigger-events" >}}). This section describes what event data you can include in your APIs, and how you can manage them with the use of webhooks and custom JavaScript handlers. This section also covers the use of monitors for user and organization quotas, as well as StatsD and NewRelic instrumentation.
 
Suggestion importance[1-10]: 9

Why: The suggestion corrects a grammatical error and improves the clarity of the sentence, which enhances the overall readability and professionalism of the documentation.

9
Expand on how the bootstrap command simplifies the bootstrapping process

The description "The bootstrap command makes bootstrapping easier." could be
expanded to explain how it simplifies the process, providing more value to the
reader.

tyk-docs/content/tyk-on-premises/bootstrapper-cli.md [36]

-The `bootstrap` command makes bootstrapping easier. It helps you to create organizations and users.
+The `bootstrap` command streamlines the bootstrapping process by automating the creation of organizations and users, reducing manual setup efforts.
 
Suggestion importance[1-10]: 8

Why: The suggestion provides additional context on how the bootstrap command simplifies the process, which adds value by explaining the benefits more clearly.

8
Improve sentence clarity and reduce redundancy in the documentation

Consider rephrasing the sentence to avoid redundancy and enhance clarity. The phrase
"managing the pages and the content" could be simplified to "managing pages and
content" since "the" is not necessary in this context.

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

-The purpose of highlighting this flow is to give recommendations on how to organize effective workflows between front end engineers and content managers. Where front end engineers are building page templates and content managers are managing the pages and the content.
+The purpose of highlighting this flow is to give recommendations on how to organize effective workflows between front end engineers and content managers, where front end engineers build page templates and content managers manage pages and content.
 
Suggestion importance[1-10]: 7

Why: The suggestion improves readability and reduces redundancy, making the documentation clearer. However, it is a minor enhancement and does not address any critical issues.

7
Simplify and clarify the description for enabling API consumer organization registration

To enhance clarity and consistency, consider rephrasing the description to avoid
redundancy and improve readability. The phrase "API Consumers can register
organizations, and the respective button appears in the navigation menu" could be
simplified.

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumer-organisations.md [41]

-* **Enable API consumers to register organizations**: when this setting is enabled, API Consumers can register organizations, and the respective button appears in the navigation menu;
+* **Enable API consumers to register organizations**: This setting allows API Consumers to register organizations, making the registration button visible in the navigation menu.
 
Suggestion importance[1-10]: 7

Why: The suggestion simplifies the sentence and improves readability, making the documentation clearer. However, it is a minor enhancement and does not address any critical issues.

7
Provide more precise location details for 'Organization ID' in the documentation

To enhance the clarity and precision of the documentation, consider specifying the
exact location of the 'Organization ID' within the user profile, as it might not be
immediately obvious to all users.

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/publish-api-products-and-plans.md [47]

-| Organization ID          | The org id is required in order to connect to Tyk as a provider. It can be found in the user profile within the Tyk Dashboard.
+| Organization ID          | The org id, required for connecting to Tyk as a provider, is located in the 'Profile' section under 'User Settings' within the Tyk Dashboard.
 
Suggestion importance[1-10]: 6

Why: While the suggestion adds clarity, the original text is already fairly clear. The improvement is helpful but not critical.

6
Clarity
Clarify the scope of domain settings to enhance understanding

The sentence "This domain will affect your API only." could be clarified further to
specify that changes to the domain settings will not impact other APIs unless
explicitly configured.

tyk-docs/content/shared/api-def-common.md [22]

-This domain will affect your API only. To set up the portal domain for your organization, please register it in the main Tyk Dashboard settings file.
+Changes to this domain setting will only affect your API and not others. To configure the portal domain for your organization, please register it in the main Tyk Dashboard settings file.
 
Suggestion importance[1-10]: 8

Why: The suggestion provides a clearer explanation of the domain settings, which helps users understand the impact of their configurations better.

8
Possible issue
Correct grammatical errors to enhance the documentation's professionalism

To improve readability and maintain consistency, consider using a consistent verb
tense in the description. The phrase "It intended for static assets" should be
corrected to "It is intended for static assets."

tyk-docs/content/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/file-structure-concepts.md [35]

-- `assets`: It intended for static assets like CSS, JS or images that are used by the theme. All contents from this directory are mounted under the `/assets` path in the portal HTTP server.
+- `assets`: It is intended for static assets like CSS, JS, or images that are used by the theme. All contents from this directory are mounted under the `/assets` path in the portal HTTP server.
 
Suggestion importance[1-10]: 8

Why: Correcting the grammatical error enhances the professionalism and readability of the documentation. This is a straightforward and necessary fix.

8
Consistency
Standardize the spelling of "organization" throughout the document

Consider using a consistent term for "organization" throughout the document to
maintain uniformity and avoid confusion. Since "organization" is used in other
sections, replace "organisation" with "organization" in all occurrences.

tyk-docs/content/tyk-stack/tyk-pump/tyk-analytics-record-fields.md [107]

-Organisation Id of API Definition requested.
+Organization Id of API Definition requested.
 
Suggestion importance[1-10]: 8

Why: The suggestion correctly identifies and addresses the inconsistency in the spelling of "organization," which improves the document's uniformity and readability.

8
Readability
Simplify the instruction for using an API key to enhance readability

The phrase "and issue a request using these credentials to create your new API and
make it live" could be simplified for better readability and directness.

tyk-docs/content/shared/create-api-include.md [80]

-You will need an API key for your organization (to authenticate with the Dashboard API) and issue a request using these credentials to create your new API and make it live.
+You will need an API key for your organization to authenticate with the Dashboard API. Use this key to issue a request that creates and activates your new API.
 
Suggestion importance[1-10]: 7

Why: The suggestion simplifies the sentence structure, making it easier to read and understand, which is beneficial for users following the instructions.

7
Improve the document's readability by using markdown conventions for line breaks

To enhance readability and maintain the consistency of the document's formatting,
consider removing the
tag and using markdown conventions for line breaks or
spacing.

tyk-docs/content/tyk-stack/tyk-pump/tyk-analytics-record-fields.md [167]

-**Remarks:** Can contain many tags which refer to many things, such as the gateway, API key, organization, API definition etc.<br/>
+**Remarks:** Can contain many tags which refer to many things, such as the gateway, API key, organization, API definition etc.
 
Suggestion importance[1-10]: 7

Why: The suggestion enhances readability by recommending the use of markdown conventions instead of HTML tags, which is more appropriate for markdown documents.

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.

None yet

2 participants