tyk-docs
tyk-docs copied to clipboard
TykTechnologies
[DX-1344] Replace whitelist/blacklist content where possible, for tier 1 compliance with inclusive naming
User description
For internal users - Please add a Jira DX PR ticket to the subject!
DX-1344
Preview Link
Description
Within the docs content there are occurrences of whitelist/blacklist. This ticket involves updating the content where possible. Due to 3rd party dependencies and configuration parameters in Tyk components, it will not be possible to update some content until the product has been updated.
Screenshots (if appropriate)
Checklist
- [ ] I have added a preview link to the PR description.
- [x] I have reviewed the guidelines for contributing to this repository.
- [x] I have read the technical guidelines for contributing to this repository.
- [x] Make sure you have started your change off our latest
master. - [x] I labelled the PR
PR Type
enhancement, documentation
Description
- Updated terminology across various documentation files to use more inclusive language.
- Changed terms like "white_list" and "black_list" to "allow_list" and "block_list".
- Modified "white label" to "customise the portal's branding" in developer portal options.
- Ensured consistency in terminology updates across all modified files.
Changes walkthrough 📝
| Relevant files | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enhancement |
|
💡 PR-Agent usage: Comment
/helpon the PR to get a list of all available PR-Agent tools and their descriptions
PS. Pls add /docs/nightly to the end of url
| Name | Link |
|---|---|
| Latest commit | 1595e26b00dc7a99a961eb64b7ee99f4584176c1 |
| Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/6646161b9d7fe70008596714 |
| Deploy Preview | https://deploy-preview-4640--tyk-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
PS. Pls add /docs/nightly to the end of url
| Name | Link |
|---|---|
| Latest commit | 2f6df7ca33a43721c5a1d433277b0dd77416cd8c |
| Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/664b293555d441000805c7cb |
| Deploy Preview | https://deploy-preview-4640--tyk-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
PR Description updated to latest commit (https://github.com/TykTechnologies/tyk-docs/commit/f6115b44b5c19142be3bcd9bc0fc14c91079eac3)
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
PR Review 🔍
| ⏱️ Estimated effort to review [1-5] |
2, because the changes are straightforward terminology updates across multiple documentation files, focusing on replacing non-inclusive terms with more inclusive alternatives. The context and functionality remain unchanged, making it easier to review. |
| 🧪 Relevant tests |
No |
| ⚡ Possible issues |
No |
| 🔒 Security concerns |
No |
Code feedback:
| relevant file | tyk-docs/content/getting-started/import-apis.md |
| suggestion |
Consider updating the JSON example to reflect the terminology changes made in the surrounding text. For instance, replace "white_list" and "black_list" with "allow_list" and "block_list" respectively in the JSON code block to maintain consistency and avoid confusion. [important] |
| relevant line | Tyk supports API mocking using our versioning `use_extended_paths` setup, adding mocked URL data to one of the three list types (white_list, black_list or ignored). In order to handle a mocked path, use an entry that has `action` set to `reply`: |
| relevant file | tyk-docs/content/shared/api-def-version.md |
| suggestion |
Update the JSON code block to use "allow_list" and "block_list" instead of "whitelist" and "blacklist". This change will ensure that the code examples are in line with the new terminology used throughout the document. [important] |
| relevant line | Extended paths allow you to control which upstream paths are to be handled in a specific way (ignored, as part of an allow list or block list) by both path and method. The extended metadata set also allows you to provide forced reply data to override or trap inbound requests for specific versions. This is very useful for mocking or slowly exposing a development API to a live upstream back end. |
| relevant file | tyk-docs/content/getting-started/key-concepts/versioning.md |
| suggestion |
Ensure that all instances of old terminology in JSON examples are updated to the new terms. For example, change "whitelist" to "allowlist" in the JSON blocks to prevent discrepancies between the documentation text and the example code. [important] |
| relevant line | "path": "v1/allowed/whitelist/literal", |
| relevant file | tyk-docs/content/product-stack/tyk-dashboard/release-notes/archived-releases/version-2.4.md |
| suggestion |
Update the terminology in the JSON code examples to match the new inclusive language used in the text. This will help in maintaining consistency throughout the document. [important] |
| relevant line | When importing Swagger based APIs they now generate tracked URLs instead of white listed ones. |
PR Code Suggestions ✨
| Category | Suggestion | Score |
| Maintainability |
Correct a typo to enhance the readability and professionalism of the documentationCorrect the typo in "idenitfy" to "identify" to maintain professionalism and readability tyk-docs/content/product-stack/tyk-dashboard/release-notes/archived-releases/version-2.4.md [18] Suggestion importance[1-10]: 10Why: The suggestion correctly identifies and corrects a typo ("idenitfy" to "identify"), which is crucial for maintaining professionalism in documentation. | 10 |
![tykbot[bot] avatar](https://avatars.githubusercontent.com/in/35290?v=4 "Published by a pub.dev verified publisher"){kind=small}