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
description: "Explains the inclusive naming initiative concerning Tyk docs"
6
+
aliases:
7
+
- /contribute
8
+
6
9
---
7
10
11
+
## How to Contribute to our Docs
12
+
13
+
We appriciate any form of engagement and contribution to our documentation. You can do it in a few ways:
14
+
-[Report an error](https://github.com/TykTechnologies/tyk-docs/issues) in our Github repo.
15
+
-[Suggest/request an improvement](https://github.com/TykTechnologies/tyk-docs/issues) in our Github repo.
16
+
- Update the code yourself:
17
+
1. If you want to be even more involved, you are welcomed to [submit PR](https://github.com/TykTechnologies/tyk-docs/pulls) directly in our [docs repo](https://github.com/TykTechnologies/tyk-docs/).
18
+
2. In order for you need to find the page that needs editing in the actual [GH docs repo](https://github.com/TykTechnologies/tyk-docs/), the best way would be to copy a sentence from that HTML page on the [docs website](https://tyk.io/docs) and look it up it using the Github search box, on the top left corner. (Since the structure of our docs is not the same as the structure in the rendered docs website, we can't easily link you to this page).
19
+
- Post a message in our [community forum](https://community.tyk.io/)
20
+
21
+
Our docs are compiled using the [Hugo static site generator](https://gohugo.io/).
22
+
23
+
The [Readme](https://github.com/TykTechnologies/tyk-docs#readme) has details of how to construct docs pages.
24
+
8
25
This document is intended for Tyk users, contributors, and anyone interested in our commitment to inclusive language within Tyk's documentation and product interfaces.
9
26
10
-
## Introduction
27
+
## Inclusive Naming project
11
28
We are excited to announce the launch of our *Inclusive Naming* project, in June 2024, dedicated to updating our documentation and aligning with the [Inclusive Naming Initiative (INI)](https://inclusivenaming.org). This initiative reflects our commitment to fostering an inclusive and respectful environment for our users and within our company.
12
29
13
30
The [Inclusive Naming Initiative](https://inclusivenaming.org/) is a community-driven effort to promote and standardize the use of inclusive language in software and documentation. By adhering to their guidelines, we aim to eliminate terms that can be considered exclusionary, offensive, or insensitive and replace them with language that is respectful and welcoming to all.
14
31
15
-
---
16
-
17
-
## Purpose
32
+
**Purpose**
18
33
19
34
Our commitment to diversity, equity, and inclusion is foundational to our values. By updating our documentation to comply with the *Inclusive Naming Initiative (INI)*, we are taking a significant step towards ensuring that our language reflects our dedication to inclusivity. This project will help us:
20
35
21
36
-**Create a more welcoming environment**: By using inclusive language, we create a space where everyone feels valued and respected.
22
37
-**Enhance accessibility**: Clear and inclusive documentation improves accessibility for all users, regardless of their background or identity.
23
38
24
-
---
25
-
26
-
## Tier 1 word list
39
+
### Tier 1 word list
27
40
28
41
INI sorts terms into word lists, considering both the severity of the term and the level of scrutiny it has received. [INI Tier 1 words](https://inclusivenaming.org/word-lists/tier-1) are considered critical and are recommended to be replaced immediately.
29
42
@@ -34,13 +47,11 @@ INI has identified that terms included in this list have one or all of the follo
34
47
- Terms where the impact of change or removal is low: for example, there is little entanglement in low-level systems or standardized language set by standards bodies
35
48
- Have passed through all the review stages in Tiers 2 and 3
36
49
37
-
---
38
-
39
-
## Phase #1: Review of Tyk Documentation for Tier 1 Words
50
+
### Phase #1: Review of Tyk Documentation for Tier 1 Words
40
51
41
52
An initial review of the Tyk documentation was conducted in April 2024 to check which tier 1 words can be replaced, which can't, and why.
42
53
43
-
### Findings and planning
54
+
####Findings and planning
44
55
The main findings of the review are:
45
56
46
57
1.**Explanatory content with INI tier 1 words**: The content on these pages can be easily rephrased and is now completed.
@@ -52,23 +63,24 @@ The main findings of the review are:
52
63
- For now, we can minimize their usage and rephrase the explanatory content to use inclusive words.
53
64
54
65
55
-
## Phase #2: Removing Tier 1 words from Tyk documentation
66
+
###Phase #2: Removing Tier 1 words from Tyk documentation
56
67
57
68
In June 2024, based on the review we executed the planned changes to the content in our [documentation](https://github.com/tykTechnologies/tyk-docs/).
58
69
59
-
### Status update
70
+
####Status update
60
71
This is the update on the status of our documentation
61
72
1.**Regular explanatory content with INI tier 1 words**: Content in the documentation has been rephrased and the work is now completed.
62
73
2.**Configuration parameters containing INI tier 1 words**: These words are still in our docs, however, we minimized their usage and rephrased their explanatory content to use inclusive words.
63
74
-**Tyk products**: These words are still in our docs, however, Tyk aims to gradually replace them (in a backward-compatible way) and update the docs accordingly.
64
75
-**Third-party and dependencies**: There's nothing much we can do at the moment except wait for them to replace these parameters, however, we are committed to updating our docs once this gets done.
65
76
66
-
### List of configuration parameters containing INI tier 1 word
77
+
####List of configuration parameters containing INI tier 1 word
67
78
For your records, the following sections highlight the existing *INI tier 1 words* in our docs, per Tyk component:
##### Tyk Classic API Definition {#gw-classic-api-definition}
94
+
###### Tyk Classic API Definition {#gw-classic-api-definition}
83
95
84
96
The [Tyk Gateway OpenAPI Document](https://github.com/TykTechnologies/tyk-docs/blob/master/tyk-docs/assets/others/gateway-swagger.yml) (Tyk Gateway swagger), includes references to the following Tyk Classic API Definition parameters:
85
97
86
98
-[version_data.versions.{version-name}.extended_paths.black_list]({{< ref "product-stack/tyk-gateway/middleware/block-list-tyk-classic#tyk-classic" >}}). There is also a parameter with equivalent functionality under the `paths` object (`version_data.versions.{version_name}.paths.black_list`).
87
99
-[version_data.versions.{version-name}.extended_paths.white_list]({{< ref "product-stack/tyk-gateway/middleware/allow-list-tyk-classic#configuring-the-allow-list-in-the-tyk-classic-api-definition" >}}). There is also a parameter with equivalent functionality under the `paths` object (`version_data.versions.{version_name}.paths.while_list`).
The [Tyk Dashboard OpenAPI Document](https://github.com/TykTechnologies/tyk-docs/blob/master/tyk-docs/assets/others/dashboard-swagger.yml) (Tyk Dashboard swagger), contains references to [the parameters from the above Tyk Classic API Definition list]({{< ref "#gw-classic-api-definition" >}}).
99
110
100
-
##### Dashboard UI
111
+
**Dashboard UI**
101
112
102
113
The Tyk Classic APIs *Endpoint Designer* shows configuration of [blacklist]({{< ref "product-stack/tyk-gateway/middleware/block-list-tyk-classic#configuring-the-block-list-in-the-api-designer" >}}) and [whitelist]({{< ref "product-stack/tyk-gateway/middleware/allow-list-tyk-classic#configuring-the-allow-list-in-the-api-designer" >}}) middleware plugins.
103
114
104
-
#### Tyk MDCB
115
+
#####Tyk MDCB
105
116
106
117
The following MDCB configuration parameters contain tier 1 word occurrences:
Content contains *INI Tier 1 word* occurrences due to the following external dependencies:
118
129
- Links to Tyk Component GitHub repositories with a default branch set as `master`.
119
130
- Tyk Gateway and Tyk Pump content use Redis terminology for `master` in relation to key storage and analytics.
120
131
- Tyk Classic Developer Portal provides [documentation]({{< ref "tyk-developer-portal/tyk-portal-classic/keycloak-dcr" >}}) that explains how to integrate Tyk with Keycloak using the [OpenID Connect Dynamic Client Registration](https://tools.ietf.org/html/rfc7591) protocol. The example in the guide uses the Keycloak default `master` realm.
121
132
- Tyk Bitnami Helm charts use a service with a DNS name of *tyk-redis-master.tyk.svc*.
0 commit comments