Maintenance/docs #446
Merged
Maintenance/docs #446
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The table has being removed in favour for better rendering on docs.kuadrant.io
Change formatting to get better rendering on docs.kuadrant.io
Reformat the list to work on docs.kuadrant.io
- remove toc - fix broken links
- remove TOC - fix list rendering - fix broken links
- remove extra spacing - fix list rendering for website
- remove TOC - fix list for website reneder - fix links
- Formatting for list render on website - Update links
26 tasks
docs/user-guides/sharding.md
Outdated
Comment on lines
25
to
26
| <li>[Sharding](../architecture.md#sharding)</li> | ||
| <li>Identity verification & authentication → [API key](../features.md#api-key-authenticationapikey)</li> |
There was a problem hiding this comment.
It seems to have broken in GitHub now.
There was a problem hiding this comment.
Sadly the only way I could get this to render correctly in both place was by using HTML list with A tags and absolute paths to page on the website.
There was a problem hiding this comment.
How is it that it works for all other user guides then? Or maybe it doesn't. In this case, why changing this particular file and not all the others?
Boomatang
force-pushed
the
maintenance/docs
branch
2 times, most recently
from
68f95cf
to
74436b1
Compare
- Fix broken links
Boomatang
force-pushed
the
maintenance/docs
branch
3 times, most recently
from
f228c84
to
d4bf470
Compare
- fix list rendering - update URLs
Boomatang
force-pushed
the
maintenance/docs
branch
from
d4bf470
to
58a8b0e
Compare
- Update list format
guicassolato
added
kind/bug
docs/getting-started.md
Outdated
Comment on lines
21
to
27
| <details markdown="1"> | ||
| <summary>Alternative: K8s distros and platforms</summary> | ||
| <details markdown="1"> | ||
| <summary>Alternative: K8s distros and platforms</summary> | ||
|
|
||
| Alternatively to upstream Kubernetes, you should be able to use any other Kubernetes distribution or Kubernetes Management Platform (KMP) with support for Kubernetes Custom Resources Definitions (CRD) and custom controllers, such as <a href="https://www.openshift.com">Red Hat OpenShift</a>, <a href="https://www.ibm.com/cloud/kubernetes-service">IBM Cloud Kubernetes Service (IKS)</a>, <a href="http://cloud.google.com/kubernetes-engine">Google Kubernetes Engine (GKE)</a>, <a href="https://aws.amazon.com/eks">Amazon Elastic Kubernetes Service (EKS)</a> and <a href="https://azure.microsoft.com/en-us/services/kubernetes-service">Azure Kubernetes Service (AKS)</a>. | ||
| </details> | ||
| Alternatively to upstream Kubernetes, you should be able to use any other Kubernetes distribution or Kubernetes Management Platform (KMP) with support for Kubernetes Custom Resources Definitions (CRD) and custom controllers, such as <a href="https://www.openshift.com">Red Hat OpenShift</a>, <a href="https://www.ibm.com/cloud/kubernetes-service">IBM Cloud Kubernetes Service (IKS)</a>, <a href="http://cloud.google.com/kubernetes-engine">Google Kubernetes Engine (GKE)</a>, <a href="https://aws.amazon.com/eks">Amazon Elastic Kubernetes Service (EKS)</a> and <a href="https://azure.microsoft.com/en-us/services/kubernetes-service">Azure Kubernetes Service (AKS)</a>. | ||
| </details> | ||
|
|
||
| - [**Envoy**](https://www.envoyproxy.io) proxy (recommended v1.19 or later), to wire up Upstream services (i.e. the services to be protected with Authorino) and external authorization filter (Authorino) for integrations based on the reverse-proxy architecture - [example](https://github.com/kuadrant/authorino-examples#envoy) | ||
|
|
||
| <details markdown="1"> | ||
| <summary>Alternative: Non-reverse-proxy integration</summary> | ||
| <details markdown="1"> | ||
| <summary>Alternative: Non-reverse-proxy integration</summary> | ||
|
|
||
| Technically, any client that implements Envoy's <a href="https://www.envoyproxy.io/docs/envoy/latest/start/sandboxes/ext_authz">external authorization</a> gRPC protocol should be compatible with Authorino. For integrations based on the reverse-proxy architecture nevertheless, we strongly recommended that you leverage Envoy alongside Authorino. | ||
| </details> | ||
| Technically, any client that implements Envoy's <a href="https://www.envoyproxy.io/docs/envoy/latest/start/sandboxes/ext_authz">external authorization</a> gRPC protocol should be compatible with Authorino. For integrations based on the reverse-proxy architecture nevertheless, we strongly recommended that you leverage Envoy alongside Authorino. | ||
| </details> |
There was a problem hiding this comment.
Does the indentation break anything? Because it was actually nesting the detail boxes inside the list items before.
Now it looks a bit weird:
There was a problem hiding this comment.
So it does seem like the indent matters for this. The mixing of html and markdown seems to have so many edge cases. What you will find now is the syntax highlighting does not work for the details section in editors. Or add least it does not work in my editors. It does seem to be working in the github diff.
- fix display indents - update URL
guicassolato
approved these changes
Nov 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Verification
To help with rendering these changes on the docs site, Kuadrant/docs.kuadrant.io#41 can be used to run these changes locally