docs: update "Getting started" guide #1247
Conversation
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
|
@tao12345666333 @juzhiyuan Please review this PR. |
|
No clue why the markdown link checks are failing. |
docs/en/latest/getting-started.md
Outdated
| | `0.5` | `>= 2.4`, `2.5` is recommended. | | ||
| | `0.4` |`>= 2.4`| | ||
| | APISIX ingress controller | Recommended APISIX version | | ||
| | ------------------------: | -------------------------: | |
There was a problem hiding this comment.
Hello, after adding Recommended in L123, the meaning is changed in my opinion. 🤔 Like in L125, it means >= 2.7 is recommended.
There was a problem hiding this comment.
Yes. You are right. I will split this into two columns. I overlooked what is actually mentioned in the column.
@navendu-pottekkat Just rerun, the report says upstream link is 504 😅 but it works now. |
@juzhiyuan I do not have access to re-run workflows! |
tao12345666333
added
the
documentation
docs/en/latest/getting-started.md
Outdated
| groupId="resources" | ||
| defaultValue="apisix" | ||
| values={[ | ||
| {label: 'APISIX custom resource', value: 'apisix'}, |
There was a problem hiding this comment.
Should be APISIX ingress custom resource.
|
It is from this PR. |
docs/en/latest/getting-started.md
Outdated
|
|
||
| APISIX ingress controller defines the CRDs [ApisixRoute](./concepts/apisix_route.md), [ApisixUpstream](./concepts/apisix_upstream.md), [ApisixTlx](concepts/apisix_tls.md), and [ApisixClusterConfig](concepts/apisix_cluster_config.md). | ||
|
|
||
| APISIX also supports [service discovery](/docs/apisix/discovery/kubernetes/) through [Kubernetes service](https://kubernetes.io/docs/concepts/services-networking/service/) abstraction. |
docs/en/latest/getting-started.md
Outdated
| - Supports service discovery through Kubernetes Service. | ||
| - Out-of-the-box node health check support. | ||
| - Supports load balancing based on pods (Upstream nodes). | ||
| - Rich [Plugins](/docs/apisix/plugins/batch-requests/) with [custom Plugin](/docs/apisix/plugin-develop/) support. |
docs/en/latest/getting-started.md
Outdated
|
|
||
| First, your supports and cooperations to make this project better are appreciated. | ||
| But before you start, please read [How to Contribute](./contribute.md) | ||
| See the [Contribute to APISIX](/docs/general/contributor-guide/) section for details on the contributing flow. |
|
@tao12345666333 These links work! I have been using this reference on APISIX docs. What do you suggest we change this to? I have tested it by building it locally. Screen.Recording.2022-08-17.at.10.35.30.PM.mov |
|
Sorry. The error in CI is indeed from this PR. But the link checker is naive. These links would work fine in the actual build. It is much better than linking to the APISIX website manually. |
|
I think we removed this check from the APISIX repo. |
Yes. The checks in CI are for this repo.
|
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat navendupottekkat@gmail.com
Updates the "Getting started" page. Also updates the ACK installation. Once these changes are approved, it will be propagated to other installation docs as well. Also rearranges installation to the top.