-
Notifications
You must be signed in to change notification settings - Fork 159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[TT-12648 DX-1578] Docs Operator Migration (API Definition and policy feature list) #5102
Conversation
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ PS. Pls add /docs/nightly to the end of url
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@caroltyk PR looking good to me. I have noticed the PR is in draft status and have performed an initial review with minor suggestions / observations:
- Expand abbreviation instances for CR and CRD Add an introduction paragraph that explains the objectives of the quick start and what the user will achieve
- Summarise what each Quickstart does before the yaml file is included
- Fix links in Quickstart and supported features table in content file tyk-docs/content/product-stack/tyk-operator/reference/security-policy.md
- Fix links in tyk-docs/content/product-stack/tyk-operator/reference/api-definition.md
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/graphql-federation.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/graphql-federation.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/graphql-federation.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/graphql-federation.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/graphql-federation.md
Outdated
Show resolved
Hide resolved
Co-authored-by: dcs3spp <[email protected]>
tyk-docs/content/product-stack/tyk-operator/reference/security-policy.md
Show resolved
Hide resolved
Co-authored-by: dcs3spp <[email protected]>
…from corresponding docs pages (#5174) * link keyless * add client to gateway links * fix links --------- Co-authored-by: Simon Pears <[email protected]>
* add gateway upstream auth config * fix links --------- Co-authored-by: Simon Pears <[email protected]>
add planned endpoint examples included in Google spreadsheet --------- Co-authored-by: Simon Pears <[email protected]> Co-authored-by: Burak Sekili <[email protected]>
Add API level global features provided in Google spreadsheet --------- Co-authored-by: Simon Pears <[email protected]> Co-authored-by: caroltyk <[email protected]>
c9dbcd8
to
2d0fe85
Compare
…tions/graphql-federation.md
…tions/graphql-federation.md
@caroltyk I have merged the API global and endpoint level feature examples included in the Google Spreadsheet into this PR. I have added preview links and summary of potential missing examples to this PR description |
@caroltyk commit removes file tyk-docs/content/product-stack/tyk-operator/advanced-configurations/api-versioning.md That content file is currently referenced from the API definition table in file tyk-docs/content/product-stack/tyk-operator/reference/api-definition.md For the Hugo build and CI checks to succeed the API definition table should be updated to remove the link to the deleted file (api versioning) and we should also setup a redirect to an alternative location if users visit that URL for the removed file. Which URL should product-stack/tyk-operator/advanced-configurations/api-versioning redirect to in order to avoid 404 page not found errors? |
I've fixed the link in last commit. |
…nition.md Co-authored-by: caroltyk <[email protected]>
…tions/custom-plugins.md Co-authored-by: caroltyk <[email protected]>
…tyk-docs into caroltyk-tyk-operator-2
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/custom-plugins.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/custom-plugins.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/custom-plugins.md
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/custom-plugins.md
Outdated
Show resolved
Hide resolved
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/custom-plugins.md
Outdated
Show resolved
Hide resolved
…tions/custom-plugins.md Co-authored-by: Komal Sukhani <[email protected]>
…tions/custom-plugins.md Co-authored-by: Komal Sukhani <[email protected]>
…tions/custom-plugins.md Co-authored-by: Komal Sukhani <[email protected]>
…e not supported in Tyk Operator and move unsupported and undocumented sections with How It Works
@caroltyk I have moved the unsupported and undocumented features as subsections of the How it works section |
@komalsukhani if you are ok with the changes and comment response would you be able to approve and I will merge and release |
/release to release-5.5 |
3 similar comments
/release to release-5.5 |
/release to release-5.5 |
/release to release-5.5 |
User description
For internal users - Please add a Jira DX PR ticket to the subject!
DX-1578
Preview Link
API Versioning
API definition features tables
Links added to Tyk Operator auth in the following pages
Tyk Operator Certificates - Gateway to upstream authentication
API (Global features)
For questions relating to API global features see description of this PR that was merged into this PR.
Endpoint level features
For questions relating to endpoint level features refer to the description of this PR that was merged into this PR.
Missing examples? (some of these features are marked as supported in API definition table)
Follow-ups
Description
Screenshots (if appropriate)
Checklist
master
.PR Type
Documentation
Description
Changes walkthrough 📝
11 files
client-authentication.md
Add documentation for client authentication configurations in Tyk
Operator
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/client-authentication.md
methods.
plugins.
internal-looping.md
Document internal looping configurations and examples
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/internal-looping.md
graphql-federation.md
Add GraphQL Federation documentation for Tyk Operator
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/graphql-federation.md
api-definition.md
Document supported features of ApiDefinition CRD
tyk-docs/content/product-stack/tyk-operator/reference/api-definition.md
custom-plugins.md
Document custom plugin configuration in Tyk Operator
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/custom-plugins.md
response-header-tyk-classic.md
Add Tyk Operator response header transform documentation
tyk-docs/content/product-stack/tyk-gateway/middleware/response-header-tyk-classic.md
Operator.
virtual-endpoint-tyk-classic.md
Document virtual endpoint configuration in Tyk Operator
tyk-docs/content/product-stack/tyk-gateway/middleware/virtual-endpoint-tyk-classic.md
url-rewrite-tyk-classic.md
Document URL rewriter configuration in Tyk Operator
tyk-docs/content/product-stack/tyk-gateway/middleware/url-rewrite-tyk-classic.md
request-header-tyk-classic.md
Add Tyk Operator request header transform documentation
tyk-docs/content/product-stack/tyk-gateway/middleware/request-header-tyk-classic.md
Operator.
upstream-mtls.md
Document upstream mTLS configuration in Tyk Operator
tyk-docs/content/basic-config-and-security/security/mutual-tls/upstream-mtls.md
upstream_certificates.
do-not-track-tyk-classic.md
Document do-not-track middleware configuration in Tyk Operator
tyk-docs/content/product-stack/tyk-gateway/middleware/do-not-track-tyk-classic.md
44 files
request-size-limit-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/request-size-limit-tyk-classic.md
...
response-body-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/response-body-tyk-classic.md
...
management-of-api.md
...
tyk-docs/content/product-stack/tyk-operator/advanced-configurations/management-of-api.md
...
versioning.md
...
tyk-docs/content/getting-started/key-concepts/versioning.md
...
endpoint-cache-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/endpoint-cache-tyk-classic.md
...
quick-start-udg.md
...
tyk-docs/content/product-stack/tyk-operator/getting-started/quick-start-udg.md
...
write-grpc-plugin.md
...
tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md
...
menu.yaml
...
tyk-docs/data/menu.yaml
...
mock-response-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/mock-response-tyk-classic.md
...
certificate-pinning.md
...
tyk-docs/content/security/certificate-pinning.md
...
allow-list-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/allow-list-tyk-classic.md
...
quick-start-http.md
...
tyk-docs/content/product-stack/tyk-operator/getting-started/quick-start-http.md
...
block-list-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/block-list-tyk-classic.md
...
circuit-breaker-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/circuit-breaker-tyk-classic.md
...
request-body-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/request-body-tyk-classic.md
...
auth-plugins.md
...
tyk-docs/content/plugins/plugin-types/auth-plugins/auth-plugins.md
...
enforced-timeout-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/enforced-timeout-tyk-classic.md
...
quick-start-graphql.md
...
tyk-docs/content/product-stack/tyk-operator/getting-started/quick-start-graphql.md
...
validate-request-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/validate-request-tyk-classic.md
...
request-method-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/request-method-tyk-classic.md
...
ignore-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/ignore-tyk-classic.md
...
internal-endpoint-tyk-classic.md
...
tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-classic.md
...
analytics-plugins.md
...
tyk-docs/content/plugins/plugin-types/analytics-plugins.md
...
cors.md
...
tyk-docs/content/tyk-apis/tyk-gateway-api/api-definition-objects/cors.md
...
create-an-api.md
...
tyk-docs/content/tyk-stack/tyk-operator/create-an-api.md
...
custom-analytics.md
...
tyk-docs/content/tyk-apis/tyk-gateway-api/api-definition-objects/custom-analytics.md
...
load-balancing.md
...
tyk-docs/content/planning-for-production/ensure-high-availability/load-balancing.md
...
secure-an-api.md
...
tyk-docs/content/tyk-stack/tyk-operator/secure-an-api.md
...
open-keyless.md
...
tyk-docs/content/basic-config-and-security/security/authentication-authorization/open-keyless.md
...
with-tyk-multi-cloud.md
...
tyk-docs/content/advanced-configuration/manage-multiple-environments/with-tyk-multi-cloud.md
...
rate-limiting.md
...
tyk-docs/content/basic-config-and-security/control-limit-traffic/rate-limiting.md
...
client-mtls.md
...
tyk-docs/content/basic-config-and-security/security/mutual-tls/client-mtls.md
...
access-an-api.md
...
tyk-docs/content/tyk-stack/tyk-operator/access-an-api.md
...
security-policy.md
...
tyk-docs/content/product-stack/tyk-operator/reference/security-policy.md
...
quick-start-tcp.md
...
tyk-docs/content/product-stack/tyk-operator/getting-started/quick-start-tcp.md
...
multiple-auth.md
...
tyk-docs/content/basic-config-and-security/security/authentication-authorization/multiple-auth.md
...
basic-auth.md
...
tyk-docs/content/basic-config-and-security/security/authentication-authorization/basic-auth.md
...
bearer-tokens.md
...
tyk-docs/content/basic-config-and-security/security/authentication-authorization/bearer-tokens.md
...
ip-blacklisting.md
...
tyk-docs/content/tyk-apis/tyk-gateway-api/api-definition-objects/ip-blacklisting.md
...
ip-whitelisting.md
...
tyk-docs/content/tyk-apis/tyk-gateway-api/api-definition-objects/ip-whitelisting.md
...
tyk-operator-multiple-organisations.md
...
tyk-docs/content/product-stack/tyk-operator/getting-started/tyk-operator-multiple-organisations.md
...
json-web-tokens.md
...
tyk-docs/content/basic-config-and-security/security/authentication-authorization/json-web-tokens.md
...
publish-an-api.md
...
tyk-docs/content/tyk-stack/tyk-operator/publish-an-api.md
...
migration.md
...
tyk-docs/content/tyk-stack/tyk-operator/migration.md
...