Skip to content

Commit

Permalink
Merging to release-5.4: [DX-1437] organise --> organize (PR 1) (#5065)
Browse files Browse the repository at this point in the history
[DX-1437] organise --> organize (PR 1) (#5065)

* organise 1

* organise fix 1

* revert email-customization.md changes
  • Loading branch information
buger authored Jul 12, 2024
1 parent 596c60a commit 1c83f4d
Show file tree
Hide file tree
Showing 28 changed files with 79 additions and 79 deletions.
2 changes: 1 addition & 1 deletion tyk-docs/content/basic-config-and-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ This section covers methods for configuring and applying security methods to Tyk
- [Control and limit traffic]({{< ref "basic-config-and-security/control-limit-traffic" >}}). This section shows you how to apply quotas, rate limits (throttling) and size limits to your APIs.
- [Reduce latency]({{< ref "basic-config-and-security/reduce-latency" >}}). This section describes methods for reducing latency in your Tyk installation.
- [Log traffic]({{< ref "product-stack/tyk-gateway/basic-config-and-security/logging-api-traffic/logging-api-traffic" >}}). This section describes how to control the capture of traffic logs for the transactions (API requests and responses) handled by your Tyk Gateways.
- [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 organisation 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 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.
2 changes: 1 addition & 1 deletion tyk-docs/content/shared/api-def-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* `session_lifetime_respects_key_expiration`: If this is set to `true` and the key expiration date is less than the `session_lifetime`, the key expiration value will be set to `session_lifetime`. Don't forget that the key expiration is set in unix timestamp but `session_lifetime` is set in seconds. Also, `session_lifetime_respects_key_expiration` exists in the global config too. When the global one is set to `true`, the one set at the API level will be ignored.

* `domain`: The domain to bind this API to. Multiple APIs can share the same domain, so long as their listen paths are unique.
This domain will affect your API only. To set up the portal domain for your organisation, please register it in the main Tyk Dashboard settings file.
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.
Your Tyk Gateway can listen on multiple domains/subdomains through the use of regular expressions, more precisely the RE2 Syntax. They are defined using the format `{name}` or `{name:pattern}`.
* `www.example.com` Matches only if domain is www.example.com
* `{subdomain:[a-z]+}.example.com` Matches dynamic subdomain
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/shared/create-api-include.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ If you select the API from the list to open it again, the API URL will be displa
## Tutorial: Create an API with the Dashboard API

It is easy to create APIs using Tyk Dashboard's own REST API.
You will need an API key for your organisation (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) and issue a request using these credentials to create your new API and make it live.

### Step 1: Obtain your Tyk Dashboard API access credentials key & Dashboard URL

Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/shared/tyk-gateway-features-include.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
---
Tyk is an open source Enterprise API Gateway, supporting REST, GraphQL, TCP and gRPC protocols.

Tyk Gateway is provided ‘Batteries-included’, with no feature lockout. Enabling your organisation to control who accesses your APIs, when they access, and how they access it.
Tyk Gateway is provided ‘Batteries-included’, with no feature lockout. Enabling your organization to control who accesses your APIs, when they access, and how they access it.

Tyk Technologies uses the same API Gateway for all its applications. Protecting, securing, and processing APIs for thousands of organisations and businesses around the world. Ideal for Open Banking, building software in the clouds as well as exposing APIs to teams, partners & consumers.
Tyk Technologies uses the same API Gateway for all its applications. Protecting, securing, and processing APIs for thousands of organizations and businesses around the world. Ideal for Open Banking, building software in the clouds as well as exposing APIs to teams, partners & consumers.

Built from the ground up to be the fastest API gateway on the planet. It does not depend on a legacy proxy underneath. It has no 3rd party dependencies aside from Redis for distributed rate-limiting and token storage. Tyk Gateway can also be deployed as part of a larger Full Lifecycle API Management platform Tyk Self-Managed which also includes Management Control Plane, Dashboard GUI and Developer Portal.

Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/tyk-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Configure custom domain for your Dashboard and Developer Portal

#### Manage environments

Create and manage multiple environments within your Tyk Cloud organisation
Create and manage multiple environments within your Tyk Cloud organization
{{< /badge >}}

{{< badge title="Administration" href="tyk-cloud/environments-deployments/managing-control-planes" >}}
Expand All @@ -74,7 +74,7 @@ Create and manage your Cloud Control Plane and Cloud Data Plane deployments

#### Manage teams & users

Create teams in your organisation, define roles and manage user access
Create teams in your organization, define roles and manage user access
{{< /badge >}}

{{< badge title="Account" href="tyk-cloud/account-billing/" >}}
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-on-premises/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ For a production environment, we recommend that the Gateway, Dashboard and Pump
| gateway.rpc.connString | | Use this setting to add the URL for your MDCB or load balancer host |
| gateway.rpc.useSSL | `true` | Set this option to `true` to use an SSL RPC connection|
| gateway.rpc.sslInsecureSkipVerify | `true` | Set this option to `true` to allow the certificate validation (certificate chain and hostname) to be skipped. This can be useful if you use a self-signed certificate |
| gateway.rpc.rpcKey | | Your organisation ID to connect to the MDCB installation |
| gateway.rpc.rpcKey | | Your organization ID to connect to the MDCB installation |
| gateway.rpc.apiKey | | This the API key of a user used to authenticate and authorize the Gateway’s access through MDCB. The user should be a standard Dashboard user with minimal privileges so as to reduce any risk if the user is compromised. The suggested security settings are read for Real-time notifications and the remaining options set to deny |
| gateway.rpc.groupId | | This is the `zone` that this instance inhabits, e.g. the cluster/data-center the Gateway lives in. The group ID must be the same across all the Gateways of a data-center/cluster which are also sharing the same Redis instance. This ID should also be unique per cluster (otherwise another Gateway cluster can pick up your keyspace events and your cluster will get zero updates). |

Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/tyk-on-premises/bootstrapper-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
date: 2019-07-30T11:30:02Z
title: Bootstrapper CLI
tags: ["Tyk Dasboard", "Self-Managed", "Bootstrapping", "CLI"]
description: "How to Bootstrap the Tyk Dashboard to create your organisation and users"
description: "How to Bootstrap the Tyk Dashboard to create your organization and users"
menu:
main:
parent: "Self-Managed Installation"
Expand Down Expand Up @@ -33,7 +33,7 @@ To list the available flags, execute `tyk-analytics bootstrap -h`:

### Description

The `bootstrap` command makes bootstrapping easier. It helps you to create organisations and users. The command needs a
The `bootstrap` command makes bootstrapping easier. It helps you to create organizations and users. The command needs a
config file path. By default, it looks at `tyk_analytics.conf` in the directory where the `tyk-analytics` binary is located.
For example:

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-on-premises/debian-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ You can choose to not install Redis, MongoDB or PostgreSQL by removing the `-t r
| gateway.rpc.connString | | Use this setting to add the URL for your MDCB or load balancer host |
| gateway.rpc.useSSL | `true` | Set this option to `true` to use an SSL RPC connection|
| gateway.rpc.sslInsecureSkipVerify | `true` | Set this option to `true` to allow the certificate validation (certificate chain and hostname) to be skipped. This can be useful if you use a self-signed certificate |
| gateway.rpc.rpcKey | | Your organisation ID to connect to the MDCB installation |
| gateway.rpc.rpcKey | | Your organization ID to connect to the MDCB installation |
| gateway.rpc.apiKey | | This the API key of a user used to authenticate and authorize the Gateway’s access through MDCB. The user should be a standard Dashboard user with minimal privileges so as to reduce any risk if the user is compromised. The suggested security settings are read for Real-time notifications and the remaining options set to deny |
| gateway.rpc.groupId | | This is the `zone` that this instance inhabits, e.g. the cluster/data-center the Gateway lives in. The group ID must be the same across all the Gateways of a data-center/cluster which are also sharing the same Redis instance. This ID should also be unique per cluster (otherwise another Gateway cluster can pick up your keyspace events and your cluster will get zero updates). |

Expand Down
8 changes: 4 additions & 4 deletions tyk-docs/content/tyk-on-premises/debian-ubuntu/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ sudo systemctl enable tyk-dashboard

Follow the [Gateway installation instructions]({{< ref "tyk-on-premises/debian-ubuntu/gateway" >}}) to connect to your Dashboard instance before you continue on to step 4.

### Step 4: Bootstrap the Tyk Dashboard with an initial User and Organisation
### Step 4: Bootstrap the Tyk Dashboard with an initial User and Organization

Go to:

Expand All @@ -272,12 +272,12 @@ You should get to the Tyk Dashboard Setup screen:

{{< img src="/img/dashboard/system-management/bootstrap_screen.png" alt="Tyk Dashboard Bootstrap Screen" >}}

### Step 5 - Create your Organisation and Default User
### Step 5 - Create your Organization and Default User

You need to enter the following:

- Your **Organisation Name**
- Your **Organisation Slug**
- Your **Organization Name**
- Your **Organization Slug**
- Your User **Email Address**
- Your User **First and Last Name**
- A **Password** for your User
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-on-premises/debian-ubuntu/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ $ ansible-playbook playbook.yaml -t `tyk-gateway-pro` or `tyk-gateway-hybrid`
| gateway.rpc.connString | | Use this setting to add the URL for your MDCB or load balancer host |
| gateway.rpc.useSSL | `true` | Set this option to `true` to use an SSL RPC connection|
| gateway.rpc.sslInsecureSkipVerify | `true` | Set this option to `true` to allow the certificate validation (certificate chain and hostname) to be skipped. This can be useful if you use a self-signed certificate |
| gateway.rpc.rpcKey | | Your organisation ID to connect to the MDCB installation |
| gateway.rpc.rpcKey | | Your organization ID to connect to the MDCB installation |
| gateway.rpc.apiKey | | This the API key of a user used to authenticate and authorize the Gateway’s access through MDCB. The user should be a standard Dashboard user with minimal privileges so as to reduce any risk if the user is compromised. The suggested security settings are read for Real-time notifications and the remaining options set to deny |
| gateway.rpc.groupId | | This is the `zone` that this instance inhabits, e.g. the cluster/data-center the Gateway lives in. The group ID must be the same across all the Gateways of a data-center/cluster which are also sharing the same Redis instance. This ID should also be unique per cluster (otherwise another Gateway cluster can pick up your keyspace events and your cluster will get zero updates). |

Expand Down
8 changes: 4 additions & 4 deletions tyk-docs/content/tyk-on-premises/docker/docker-pro-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,17 @@ This will will download and setup the five Docker containers. This may take some

### Step #5 - Bootstrap the Tyk installation

Go to [http://localhost:3000](http://localhost:3000) in your browser. You will be presented with the Bootstrap UI to create your first organisation and admin user.
Go to [http://localhost:3000](http://localhost:3000) in your browser. You will be presented with the Bootstrap UI to create your first organization and admin user.

{{< img src="/img/dashboard/system-management/tyk-bootstrap.png" alt="Tyk Bootstrap sceen" width="768">}}


### Step #6 - Create your organisation and default user
### Step #6 - Create your organization and default user

You need to enter the following:

* Your **Organisation Name**
* Your **Organisation Slug**
* Your **Organization Name**
* Your **Organization Slug**
* Your User **Email Address**
* Your User **First and Last Name**
* A **Password** for your User
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ You should get to the Tyk Dashboard Setup screen:

{{< img src="/img/dashboard/system-management/bootstrap_screen.png" alt="Tyk Dashboard Bootstrap Screen" >}}

### Step Six - Create your Organisation and Default User
### Step Six - Create your Organization and Default User

You need to enter the following:

- Your **Organisation Name**
- Your **Organisation Slug**
- Your **Organization Name**
- Your **Organization Slug**
- Your User **Email Address**
- Your User **First and Last Name**
- A **Password** for your User
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ You should get to the Tyk Dashboard Setup screen:

{{< img src="/img/dashboard/system-management/bootstrap_screen.png" alt="Tyk Dashboard Bootstrap Screen" >}}

### Step Seven - Create your Organisation and Default User
### Step Seven - Create your Organization and Default User

You need to enter the following:

- Your **Organisation Name**
- Your **Organisation Slug**
- Your **Organization Name**
- Your **Organization Slug**
- Your User **Email Address**
- Your User **First and Last Name**
- A **Password** for your User
Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/tyk-on-premises/installation/on-heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ However, it doesn't yet have any accounts. It order to populate it please run th
dashboard/bootstrap.sh evening-beach-40625.herokuapp.com
```
```
Creating Organisation
Creating Organization
ORGID: 5b016ca530867500050b9e90
Adding new user
USER AUTH: a0f7c1e878634a60599dc037489a880f
Expand All @@ -279,7 +279,7 @@ User: [email protected]
Pass: test123
```

It will generate a default organisation with random admin username and a specified password. The bootstrap script can be edited to suit your needs as well as just editing the user info in the dashboard.
It will generate a default organization with random admin username and a specified password. The bootstrap script can be edited to suit your needs as well as just editing the user info in the dashboard.

If this was successful, you should be able to log into your dashboard now.

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-on-premises/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Do you need support for centrally managing your APIs while deploying edge gatewa
✅ For managing your APIs centrally while deploying edge gateways in independent clusters / regions <br />
✅ For the highest availability across data centers <br />
✅ For Kubernetes-based deployment in multiple cluster / multiple regions <br />
✅ For larger organisations [with multiple teams]({{< ref "tyk-multi-data-centre.md" >}}) and [data sovereignty](https://tyk.io/blog/strategies-for-dealing-with-data-sovereignty-at-scale/) requirements <br />
✅ For larger organizations [with multiple teams]({{< ref "tyk-multi-data-centre.md" >}}) and [data sovereignty](https://tyk.io/blog/strategies-for-dealing-with-data-sovereignty-at-scale/) requirements <br />

The license starts with 3 environments and 2 regions, can be extended to more environments and regions as needed.

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-on-premises/redhat-rhel-centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ You can choose to not install Redis, MongoDB or PostgreSQL by removing the `-t r
| gateway.rpc.connString | | Use this setting to add the URL for your MDCB or load balancer host |
| gateway.rpc.useSSL | `true` | Set this option to `true` to use an SSL RPC connection|
| gateway.rpc.sslInsecureSkipVerify | `true` | Set this option to `true` to allow the certificate validation (certificate chain and hostname) to be skipped. This can be useful if you use a self-signed certificate |
| gateway.rpc.rpcKey | | Your organisation ID to connect to the MDCB installation |
| gateway.rpc.rpcKey | | Your organization ID to connect to the MDCB installation |
| gateway.rpc.apiKey | | This the API key of a user used to authenticate and authorize the Gateway’s access through MDCB. The user should be a standard Dashboard user with minimal privileges so as to reduce any risk if the user is compromised. The suggested security settings are read for Real-time notifications and the remaining options set to deny |
| gateway.rpc.groupId | | This is the `zone` that this instance inhabits, e.g. the cluster/data-center the Gateway lives in. The group ID must be the same across all the Gateways of a data-center/cluster which are also sharing the same Redis instance. This ID should also be unique per cluster (otherwise another Gateway cluster can pick up your keyspace events and your cluster will get zero updates). |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The Tyk Enterprise Developer Portal facilitates the configuration of various rat
To achieve this, the portal, by default, populates the following attributes in the credential metadata, which can be used as part of a custom rate limit key:
- **ApplicationID**: The ID of the application to which the credential belongs.
- **DeveloperID**: The ID of the developer who created the credential.
- **OrganisationID**: The ID of the organisation to which the developer belongs.
- **OrganizationID**: The ID of the organization to which the developer belongs.

Additionally, it's possible to attach [custom attribute values]({{< ref "product-stack/tyk-enterprise-developer-portal/portal-customisation/customise-user-model#add-attributes-to-the-user-model" >}}) defined in a developer profile as metadata fields to credentials.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ If you are interested in getting access contact us at [[email protected]](<mailto:s
{{< /note >}}

## Introduction
For organisations with content manager(s) managing the developer portal content, we are recommending the following workflow.
For organizations with content manager(s) managing the developer portal content, we are recommending the following workflow.

{{< img src="/img/dashboard/portal-management/enterprise-portal/portal-content-manager-flow.png" alt="Content manager workflow" >}}

The Tyk Developer portal supports the workflow of content managers who're responsible for editing and managing page content.
The purpose of highlighting this flow is to give recommendations on how to organise 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 are building page templates and content managers are managing the pages and the content.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ The Tyk Enterprise Developer Portal uses themes for customizing the live portal.
This section provides a complete guide to full customization from the developer's point of view.

## Introduction
For organisations with developers customizing pages layout and other technical aspects of the portal pages, we are recommending the following workflow.
For organizations 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" >}}
Loading

0 comments on commit 1c83f4d

Please sign in to comment.