kumahq / kuma-website

🐻 The official website for Kuma, the control plane for modern service connectivity.
https://kuma.io
Apache License 2.0
104 stars 87 forks source link

Doc bold font issue #1764

Closed Icarus9913 closed 2 months ago

Icarus9913 commented 2 months ago

What happened?

https://kuma.io/docs/2.7.x/introduction/overview-of-kuma/

WeChat0bd4c0c0b26cfa3ceab2db9cb2456f39

Icarus9913 commented 2 months ago

For the first issue line, I think we fix it with (Just move ** into the if conditional check)

* {% if_version gte:2.6.x %}**Single-zone{% endif_version %}{% if_version lte:2.5.x %}**Standalone{% endif_version %} and multi-zone**: Supports multiple clouds, regions, and Kubernetes clusters with native DNS service discovery and ingress capability.

But for the latter sub-list gramma, I tried the upper way but not works. @johncowen Do you have any ideas?

image
johncowen commented 2 months ago

Hmm yeah weird, its this fiddly if_version thing again 🤔

I had a mess around with different approaches to listing/linebreaks and things, but couldn't get it to do what we want.

I wonder if just making completely separate lists for the different versions would be better? There would be some duplication but at least we might be able to get it to render how we want?

Icarus9913 commented 2 months ago

Hmm yeah weird, its this fiddly if_version thing again 🤔

I had a mess around with different approaches to listing/linebreaks and things, but couldn't get it to do what we want.

I wonder if just making completely separate lists for the different versions would be better? There would be some duplication but at least we might be able to get it to render how we want?

Yeah, I think that will be pretty simple and direct. There's only one thing that I concerned, we used lot's of if_version gramma for docs and I just change this place or we change the whole ?

johncowen commented 2 months ago

If it was me I'd just do it here for now (if that solves the issue here)

I remember seeing a PR somewhere for improving how if_version works, not sure if thats applied here yet or will come soon, so it might be less fiddly to use pretty soon.

Icarus9913 commented 2 months ago

@johncowen Hey jc, I just forgot. This page is only one. It's an overview page to summary the whole versions.

I mean, it seems like we can not do separate lists for different versions because all different versions share the common one page.

johncowen commented 2 months ago

I 'think' (but not totally sure 😅 ) that something like the following would do it. There's plenty of repetition but it works fine 🤷‍♂️ .

(just to note I'm not totally sure that the below versioning is correct, but if not we just need to make more variations of full lists)

What do you think?

{% if_version lte:2.5.x %}
* **Universal and Kubernetes-native**: Platform-agnostic, can run and operate anywhere.
* **Standalone and multi-zone**: Supports multiple clouds, regions, and Kubernetes clusters with native DNS service discovery and ingress capability.
  * [Read more about standalone deployments](/docs/{{ page.version }}/production/deployment/stand-alone/)
  * [Read more about multi-zone deployments](/docs/{{ page.version }}/production/deployment/multi-zone/)
* **Multi-mesh**: Supports multiple individual meshes with one control plane, lowering the operational costs of supporting the entire organization.
* **Attribute-based policies**: Lets you apply fine grained service and traffic policies with any arbitrary tag selector for `sources` and `destinations`.
* **Envoy-based**: Powered by Envoy sidecar proxies, without exposing the complexity of Envoy itself.
* **Horizontally scalable**
* **Enterprise-ready**: Supports mission critical enterprise use cases that require uptime and stability.
{% endif_version %}

{% if_version gte:2.6.x %}
* **Universal and Kubernetes-native**: Platform-agnostic, can run and operate anywhere.
* **Single-zone and multi-zone**: Supports multiple clouds, regions, and Kubernetes clusters with native DNS service discovery and ingress capability.
  * [Read more about single-zone deployments](/docs/{{ page.version }}/production/deployment/single-zone/)
  * [Read more about multi-zone deployments](/docs/{{ page.version }}/deployments/multi-zone)
* **Multi-mesh**: Supports multiple individual meshes with one control plane, lowering the operational costs of supporting the entire organization.
* **Attribute-based policies**: Lets you apply fine grained service and traffic policies with any arbitrary tag selector for `sources` and `destinations`.
* **Envoy-based**: Powered by Envoy sidecar proxies, without exposing the complexity of Envoy itself.
* **Horizontally scalable**
* **Enterprise-ready**: Supports mission critical enterprise use cases that require uptime and stability.
{% endif_version %}
Icarus9913 commented 2 months ago

Agree, this is a good idea and we can do this.👍🏻