netlify[bot]
commented
1 week ago PS. Pls add /docs/nightly to the end of url
| Name | Link |
|---|---|
| Latest commit | 318f3d33bc63aa0a4ec2a95af19baac14329a64e |
| Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/66deb4542256a500085e369a |
| Deploy Preview | https://deploy-preview-5366--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.
User description
https://deploy-preview-5366--tyk-docs.netlify.app/docs/nightly/getting-started/key-concepts/versioning
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master.Update hyperlink format for better compatibility and readability
___ **Update the hyperlink to use a more standard markdown link format without the Hugoshortcodes, which might not be supported or necessary in all markdown viewers or
repositories.** [tyk-docs/content/basic-config-and-security/security/authentication-authorization/basic-auth.md [76]](https://github.com/TykTechnologies/tyk-docs/pull/5366/files#diff-ef06b4b6d40715f71447a5e359f174880bc728b79f66a1dac83605555b6569fdR76-R76) ```diff -Please consult the Tyk Operator supporting documentation for an example of how to [enable basic authentication]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#basic-authentication" >}}) with Tyk Operator. +Please consult the Tyk Operator supporting documentation for an example of how to [enable basic authentication](/product-stack/tyk-operator/advanced-configurations/client-authentication#basic-authentication) with Tyk Operator. ```
Suggestion importance[1-10]: 8
Why: The suggestion improves compatibility and readability by using a standard markdown link format, which is more universally supported than Hugo shortcodes.Remove unnecessary code block options from YAML configuration to avoid confusion
___ **Consider removing thelinenos=table,hl_lines=["8-9"],linenostart=1from the YAMLcode block as it might not be necessary for YAML configuration and could potentially
confuse users. These options are typically used for documentation purposes to
highlight specific lines and are not part of the YAML syntax.** [tyk-docs/content/advanced-configuration/manage-multiple-environments/with-tyk-multi-cloud.md [50-66]](https://github.com/TykTechnologies/tyk-docs/pull/5366/files#diff-19a2c34107181ccee3dc99cb4e639868ae543027dee22aa994a78fb356e36913R50-R66) ```diff -```yaml {linenos=table,hl_lines=["8-9"],linenostart=1} +```yaml apiVersion: tyk.tyk.io/v1alpha1 kind: ApiDefinition metadata: name: httpbin spec: name: httpbin use_keyless: true tags: - edge protocol: http active: true proxy: target_url: http://httpbin.org listen_path: /httpbin strip_listen_path: true ``` ```
Suggestion importance[1-10]: 7
Why: The suggestion correctly identifies that the line numbering and highlighting options are unnecessary for YAML configuration and could confuse users. Removing them improves clarity and readability.Improve image alt text for better accessibility and SEO
___ **It's recommended to use a more descriptive alt text for the image to improveaccessibility and SEO.** [tyk-docs/content/basic-config-and-security/security/mutual-tls/client-mtls.md [94]](https://github.com/TykTechnologies/tyk-docs/pull/5366/files#diff-2b0dd87792cba57bb16f7c1cbbdcc29761a48e5b4443a550645bfc86686979a2R94-R94) ```diff -{{< img src="/img/2.10/client_mtls_multiple_auth.png" alt="enable_cert" >}} +{{< img src="/img/2.10/client_mtls_multiple_auth.png" alt="Client mTLS Configuration Example" >}} ```
Suggestion importance[1-10]: 6
Why: The suggestion enhances accessibility and SEO by providing a more descriptive alt text, which is a good practice for web content.Separate configuration examples into different blocks for clarity
___ **To enhance the readability and maintainability of the code, consider separating theconfiguration examples into different code blocks for each platform (Tyk Gateway and
Tyk Operator), rather than using a single code block with comments.** [tyk-docs/content/plugins/plugin-types/analytics-plugins.md [69-72]](https://github.com/TykTechnologies/tyk-docs/pull/5366/files#diff-a1ac3479e138cc32d45789e39591e91d2983c713bca94825ab56fe6262b1c906R69-R72) ```diff -```yaml {linenos=table,hl_lines=["15-18"],linenostart=1} +```yaml +# Tyk Gateway Configuration +{ + "analytics_plugin": { + "enable": true, + "func_name": "MaskAnalyticsData", + "plugin_path": "/opt/tyk-gateway/plugins/example-plugin.so" + } +} +``` +```yaml +# Tyk Operator Configuration apiVersion: tyk.tyk.io/v1alpha1 kind: ApiDefinition metadata: name: analytics-plugin spec: name: httpbin-analytics-plugin active: true protocol: http proxy: listen_path: /httpbin strip_listen_path: true target_url: http://httpbin.org use_keyless: true enable_detailed_recording: true analytics_plugin: enable: true - func_name: MaskAnalyticsData # Replace it with function name of your plugin - plugin_path: /opt/tyk-gateway/plugins/example-plugin.so # Replace it with path of your plugin file + func_name: MaskAnalyticsData + plugin_path: /opt/tyk-gateway/plugins/example-plugin.so ``` ```
Suggestion importance[1-10]: 7
Why: Separating configuration examples into distinct blocks for each platform improves readability and maintainability, making it easier for users to find relevant information for their specific use case.