tyk-docs
tyk-docs copied to clipboard
[DX-1343] Replace master/slave 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!
Preview Link
Description
Within the docs content there are occurrences of master/slave. 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 from 'master/slave' to 'primary/replica' and 'workers' across multiple documentation pages to align with inclusive language guidelines.
- Minor formatting adjustment in TCP proxy documentation without altering the content.
Changes walkthrough 📝
Relevant files | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Enhancement |
| ||||||||||
Formatting |
|
💡 PR-Agent usage: Comment
/help
on 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 | 4081352fce06b011f10e5d4fa7702264c23f55db |
Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/6646174f02ce1f000897831a |
Deploy Preview | https://deploy-preview-4641--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.
PS. Pls add /docs/nightly to the end of url
Name | Link |
---|---|
Latest commit | 9de5495586500aa4fc9c6df88637430b40c95580 |
Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/6650aa5577dfe30008bc8522 |
Deploy Preview | https://deploy-preview-4641--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/b5195f62a44de4b29943aa416bc62178f7caf5d7)
PR Review 🔍
⏱️ Estimated effort to review [1-5] |
2, because the changes are straightforward and mainly involve terminology updates from non-inclusive to inclusive language. The PR is well-documented and the changes are clearly described, making it easier to review. |
🧪 Relevant tests |
No |
⚡ Possible issues |
No |
🔒 Security concerns |
No |
Code feedback:
relevant file | tyk-docs/content/key-concepts/tcp-proxy.md |
suggestion |
The sentence still mentions "Redis master" which should be updated to "Redis primary" for consistency with the inclusive language initiative. [important] |
relevant line | Here is quite a complex example of using health checks, which shows a Redis Sentinel setup. In this configuration, we put a TCP proxy, e.g. Tyk, on top of two or more Redis nodes, and the role of the proxy will always direct the user to Redis master. |
PR Code Suggestions ✨
Category | Suggestion | Score |
Security |
Add a security note about sharing secrets across environmentsConsider adding a note or warning about the security implications of sharing the tyk-docs/content/basic-config-and-security/security/mutual-tls/concepts.md [88-89]
Suggestion importance[1-10]: 7Why: The suggestion to add a security note is relevant and enhances the documentation by highlighting potential security risks. It directly relates to the new code added about sharing secrets. | 7 |
Enhancement |
Clarify the primary node election process in uptime testsClarify the election process for the primary node in uptime tests to enhance tyk-docs/content/planning-for-production/ensure-high-availability/uptime-tests.md [24]
Suggestion importance[1-10]: 6Why: The suggestion to clarify the election process is valid and improves understanding. However, it does not address any critical functionality or security issue, hence the moderate score. | 6 |
Explain the roles of primary and replica instances in a Redis clusterAdd a brief explanation about the role of primary and replica instances in a Redis cluster tyk-docs/content/tyk-stack/tyk-gateway/configuration/redis-cluster.md [127]
Suggestion importance[1-10]: 6Why: The suggestion to explain the roles of primary and replica instances is useful for reader comprehension. It's a good enhancement but not critical to the functionality or security of the system. | 6 |
Thanks for reviewing and giving feedback on this @andyo-tyk
I have committed your suggestions. Should I use deployments instead of environments for the MDCB content?
@caroltyk Are you ok with the suggestions made in https://deploy-preview-4641--tyk-docs.netlify.app/docs/nightly/basic-config-and-security/security/mutual-tls/concepts
@andyo-tyk Thanks, I have committed suggestions with suggested changes for review
@caroltyk Are you ok with the suggestions made in https://deploy-preview-4641--tyk-docs.netlify.app/docs/nightly/basic-config-and-security/security/mutual-tls/concepts
/release to release-5.3
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR
/release to release-5.2
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR
/release to release-5.1
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR
/release to release-5
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR