Skip to content

Commit

Permalink
docs: rename practices to tutorials and add index (#1123)
Browse files Browse the repository at this point in the history
  • Loading branch information
tao12345666333 committed Jun 30, 2022
1 parent b1dc75e commit 810f1a1
Show file tree
Hide file tree
Showing 35 changed files with 30 additions and 21 deletions.
25 changes: 17 additions & 8 deletions docs/en/latest/config.json
Expand Up @@ -7,14 +7,20 @@
},
{
"type": "category",
"label": "Practices",
"label": "Tutorials",
"items": [
"practices/index",
"practices/check-crd-status",
"practices/mtls",
"practices/the-hard-way",
"practices/proxy-the-httpbin-service-with-ingress",
"practices/proxy-the-httpbin-service"
"tutorials/index",
"tutorials/check-crd-status",
"tutorials/mtls",
"tutorials/the-hard-way",
"tutorials/proxy-the-httpbin-service-with-ingress",
"tutorials/proxy-the-httpbin-service",
"tutorials/proxy-grpc-service",
"tutorials/manage-certificates-with-cert-manager",
"tutorials/manage-ingress-certificates-with-cert-manager",
"tutorials/enable-authentication-and-restriction",
"tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s",
"tutorials/how-to-use-go-plugin-runner-in-apisix-ingress"
]
},
{
Expand Down Expand Up @@ -51,7 +57,10 @@
"label": "Concepts",
"items": [
"concepts/apisix_route",
"concepts/apisix_upstream"
"concepts/apisix_upstream",
"concepts/apisix_tls",
"concepts/apisix_cluster_config",
"concepts/annotations"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/ack.md
Expand Up @@ -70,7 +70,7 @@ etcd:
size: 20Gi
```

Try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.

### Specify The Ingress Version

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/aws.md
Expand Up @@ -61,7 +61,7 @@ kubectl get service apisix-gateway --namespace ingress-apisix -o jsonpath='{.sta

Now open your [EKS console](https://console.aws.amazon.com/eks/home), choosing your cluster and clicking the Workloads tag, you'll see all pods of Apache APISIX, etcd and apisix-ingress-controller are ready.

Try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.

### Specify The Ingress Version

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/azure.md
Expand Up @@ -59,7 +59,7 @@ The gateway service type is set to `LoadBalancer`, so that clients can access Ap
kubectl get service apisix-gateway --namespace ingress-apisix -o jsonpath='{.status.loadBalancer.ingress[].ip}'
```

Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.

### Specify The Ingress Version

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/gke.md
Expand Up @@ -59,7 +59,7 @@ The gateway service type is set to `LoadBalancer`, so that clients can access Ap
kubectl get service apisix-gateway --namespace ingress-apisix -o jsonpath='{.status.loadBalancer.ingress[].ip}'
```

Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.

### Specify The Ingress Version

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/k3s-rke.md
Expand Up @@ -61,4 +61,4 @@ Five Service resources were created.
The gateway service type is set to `NodePort`, so that clients can access Apache APISIX through the Node IPs and the assigned port.
If you are using K3S and you want to expose a `LoadBalancer` service, try to use [Klipper](https://github.com/k3s-io/klipper-lb).

Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/kind.md
Expand Up @@ -67,4 +67,4 @@ Five Service resources were created.
* `apisix-ingress-controller`, which exposes apisix-ingress-controller's metrics.
* `apisix-etcd` and `apisix-etcd-headless` for etcd service and internal communication.

Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running of Ingress APISIX. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running of Ingress APISIX. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/kubesphere.md
Expand Up @@ -57,7 +57,7 @@ Five Service resources were created.
The gateway service type is set to `NodePort`, so that clients can access Apache APISIX through the Node IPs and the assigned port.
If you want to expose a `LoadBalancer` service, try to use [Porter](https://github.com/kubesphere/porter).

Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.

### Specify The Ingress Version

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/minikube.md
Expand Up @@ -52,4 +52,4 @@ Five Service resources were created.
* `apisix-ingress-controller`, which exposes apisix-ingress-controller's metrics.
* `apisix-etcd` and `apisix-etcd-headless` for etcd service and internal communication.

Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running of Ingress APISIX. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Now try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running of Ingress APISIX. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/tke.md
Expand Up @@ -66,7 +66,7 @@ kubectl get service apisix-gateway --namespace ingress-apisix -o jsonpath='{.sta

Now open your [TKE console](https://console.cloud.tencent.com/tke2/overview), choosing your cluster and clicking the Workloads tag, you'll see all pods of Apache APISIX, etcd and apisix-ingress-controller are ready.

Try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.
Try to create some [resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts) to verify the running status. As a minimalist example, see [proxy-the-httpbin-service](../tutorials/proxy-the-httpbin-service.md) to learn how to apply resources to drive the apisix-ingress-controller.

### Specify The Ingress Version

Expand Down
File renamed without changes.
Expand Up @@ -42,7 +42,7 @@ Assume that the SSL port is `9443`.

## Create Issuer

For testing purposes, we will use a simple CA issuer. All required files can be found [here](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/practices/cert-manager).
For testing purposes, we will use a simple CA issuer. All required files can be found [here](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/tutorials/cert-manager).

To create a CA issuer, use the following commands:

Expand Down
Expand Up @@ -42,7 +42,7 @@ Assume that the SSL port is `9443`.

## Create Issuer

For testing purposes, we will use a simple CA issuer. All required files can be found [here](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/practices/cert-manager).
For testing purposes, we will use a simple CA issuer. All required files can be found [here](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/tutorials/cert-manager).

To create a CA issuer, use the following commands:

Expand Down
Expand Up @@ -88,7 +88,7 @@ It should output:

Before configuring SSL, we must have certificates. Certificates often authorized by certificate provider, which also known as Certification Authority (CA).

You can use [OpenSSL](https://en.wikipedia.org/wiki/Openssl) to generate self-signed certificates for testing purposes. Some pre-generated certificates for this guide are [here](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/practices/mtls).
You can use [OpenSSL](https://en.wikipedia.org/wiki/Openssl) to generate self-signed certificates for testing purposes. Some pre-generated certificates for this guide are [here](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/tutorials/mtls).

- `ca.pem`: The root CA.
- `server.pem` and `server.key`: Server certificate used to enable SSL (https). Contains correct `subjectAltName` matches domain `mtls.httpbin.local`.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion install.md
Expand Up @@ -46,4 +46,4 @@ Then you need to know which parameter need to be tweaked. If APISIX access token

## Verify Installation

There are a lot of use examples (See [samples](docs/en/latest/practices/index.md) for more details), try to follow the operations there to verify the installation.
There are a lot of use examples (See [samples](docs/en/latest/tutorials/index.md) for more details), try to follow the operations there to verify the installation.

0 comments on commit 810f1a1

Please sign in to comment.