You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ju...@apache.org on 2021/02/24 09:32:55 UTC

[apisix-ingress-controller] branch master updated: docs: modify the docs directory (#263)

This is an automated email from the ASF dual-hosted git repository.

juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git


The following commit(s) were added to refs/heads/master by this push:
     new da009dd  docs: modify the docs directory (#263)
da009dd is described below

commit da009ddebca2442eb77a5273a13de2c8a766cf40
Author: guoqqqi <72...@users.noreply.github.com>
AuthorDate: Wed Feb 24 17:32:46 2021 +0800

    docs: modify the docs directory (#263)
---
 README.md                                             |  18 +++++++++---------
 docs/{ => assets}/images/cascade-update.png           | Bin
 docs/{ => assets}/images/diff-flow.png                | Bin
 docs/{ => assets}/images/diff-rules.png               | Bin
 docs/{ => assets}/images/first.png                    | Bin
 docs/{ => assets}/images/flow.png                     | Bin
 docs/{ => assets}/images/hierarchical.png             | Bin
 docs/{ => assets}/images/module-0.png                 | Bin
 docs/{ => assets}/images/module-1.png                 | Bin
 docs/{ => assets}/images/module.png                   | Bin
 docs/{ => assets}/images/modules.png                  | Bin
 docs/{ => assets}/images/scene.png                    | Bin
 docs/{ => assets}/images/struct-compare.png           | Bin
 docs/{ => assets}/images/sync-logic-controller.png    | Bin
 docs/{ => en/latest}/CRD-specification.md             |   0
 docs/{ => en/latest}/FAQ.md                           |   0
 docs/en/latest/config.json                            |   4 ++++
 docs/{ => en/latest}/contribute.md                    |   0
 docs/{ => en/latest}/deployments/ack.md               |   0
 docs/{ => en/latest}/deployments/aws.md               |   0
 docs/{ => en/latest}/deployments/azure.md             |   0
 docs/{ => en/latest}/deployments/gke.md               |   0
 docs/{ => en/latest}/deployments/k3s-rke.md           |   0
 docs/{ => en/latest}/deployments/kubesphere.md        |   0
 docs/{ => en/latest}/deployments/minikube.md          |   0
 docs/{ => en/latest}/deployments/tke.md               |   0
 docs/{ => en/latest}/design.md                        |  12 ++++++------
 docs/{ => en/latest}/development.md                   |   0
 docs/{ => en/latest}/install.md                       |   0
 docs/{ => en/latest}/samples/index.md                 |   0
 .../samples/proxy-the-httpbin-service-with-ingress.md |   0
 .../latest}/samples/proxy-the-httpbin-service.md      |   0
 docs/{ => en/latest}/usage.md                         |   4 ++--
 33 files changed, 21 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 0858f0f..040619b 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ All configurations in `apisix-ingress-controller` are defined with Kubernetes CR
 
 The technical architecture of `apisix-ingress-controller`:
 
-<img src="./docs/images/module-0.png" alt="Architecture" width="600" height="313" />
+<img src="./docs/assets/images/module-0.png" alt="Architecture" width="600" height="313" />
 
 ## Status
 
@@ -49,7 +49,7 @@ This project is currently considered experimental.
 
 ## Modules
 
-<img src="./docs/images/module-1.png" alt="module" width="600" height="313" />
+<img src="./docs/assets/images/module-1.png" alt="module" width="600" height="313" />
 
 ### 1. `Ingress types` Submodule
 
@@ -81,11 +81,11 @@ This project is currently considered experimental.
 
 - Match and covert Apisix-ingress-types to Apisix-types before handing the control over to the above module `seven`.
 
-Get more [implementation details](./docs/design.md).
+Get more [implementation details](./docs/en/latest/design.md).
 
 ## Get started
 
-* [How to install](./docs/install.md)
+* [How to install](./docs/en/latest/install.md)
 
 ## Todos
 
@@ -97,13 +97,13 @@ Get more [implementation details](./docs/design.md).
 
 ## Documents
 
-* [Usage](./docs/usage.md)
-* [SDK doc](./docs/develop.md)
-* [Design introduction](./docs/design.md)
+* [Usage](./docs/en/latest/usage.md)
+* [SDK doc](./docs/en/latest/develop.md)
+* [Design introduction](./docs/en/latest/design.md)
 
 ## FAQ
 
-* [FAQ](./docs/FAQ.md)
+* [FAQ](./docs/en/latest/FAQ.md)
 
 ## User stories
 
@@ -114,7 +114,7 @@ Get more [implementation details](./docs/design.md).
 
 We welcome all kinds of contributions from the open-source community, individuals and partners.
 
-* [Contributing Guide](./docs/contribute.md)
+* [Contributing Guide](./docs/en/latest/contribute.md)
 
 ## Community
 
diff --git a/docs/images/cascade-update.png b/docs/assets/images/cascade-update.png
similarity index 100%
rename from docs/images/cascade-update.png
rename to docs/assets/images/cascade-update.png
diff --git a/docs/images/diff-flow.png b/docs/assets/images/diff-flow.png
similarity index 100%
rename from docs/images/diff-flow.png
rename to docs/assets/images/diff-flow.png
diff --git a/docs/images/diff-rules.png b/docs/assets/images/diff-rules.png
similarity index 100%
rename from docs/images/diff-rules.png
rename to docs/assets/images/diff-rules.png
diff --git a/docs/images/first.png b/docs/assets/images/first.png
similarity index 100%
rename from docs/images/first.png
rename to docs/assets/images/first.png
diff --git a/docs/images/flow.png b/docs/assets/images/flow.png
similarity index 100%
rename from docs/images/flow.png
rename to docs/assets/images/flow.png
diff --git a/docs/images/hierarchical.png b/docs/assets/images/hierarchical.png
similarity index 100%
rename from docs/images/hierarchical.png
rename to docs/assets/images/hierarchical.png
diff --git a/docs/images/module-0.png b/docs/assets/images/module-0.png
similarity index 100%
rename from docs/images/module-0.png
rename to docs/assets/images/module-0.png
diff --git a/docs/images/module-1.png b/docs/assets/images/module-1.png
similarity index 100%
rename from docs/images/module-1.png
rename to docs/assets/images/module-1.png
diff --git a/docs/images/module.png b/docs/assets/images/module.png
similarity index 100%
rename from docs/images/module.png
rename to docs/assets/images/module.png
diff --git a/docs/images/modules.png b/docs/assets/images/modules.png
similarity index 100%
rename from docs/images/modules.png
rename to docs/assets/images/modules.png
diff --git a/docs/images/scene.png b/docs/assets/images/scene.png
similarity index 100%
rename from docs/images/scene.png
rename to docs/assets/images/scene.png
diff --git a/docs/images/struct-compare.png b/docs/assets/images/struct-compare.png
similarity index 100%
rename from docs/images/struct-compare.png
rename to docs/assets/images/struct-compare.png
diff --git a/docs/images/sync-logic-controller.png b/docs/assets/images/sync-logic-controller.png
similarity index 100%
rename from docs/images/sync-logic-controller.png
rename to docs/assets/images/sync-logic-controller.png
diff --git a/docs/CRD-specification.md b/docs/en/latest/CRD-specification.md
similarity index 100%
rename from docs/CRD-specification.md
rename to docs/en/latest/CRD-specification.md
diff --git a/docs/FAQ.md b/docs/en/latest/FAQ.md
similarity index 100%
rename from docs/FAQ.md
rename to docs/en/latest/FAQ.md
diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
new file mode 100644
index 0000000..b029746
--- /dev/null
+++ b/docs/en/latest/config.json
@@ -0,0 +1,4 @@
+{
+  "version": "0.3.0",
+  "sidebar": {}
+}
diff --git a/docs/contribute.md b/docs/en/latest/contribute.md
similarity index 100%
rename from docs/contribute.md
rename to docs/en/latest/contribute.md
diff --git a/docs/deployments/ack.md b/docs/en/latest/deployments/ack.md
similarity index 100%
rename from docs/deployments/ack.md
rename to docs/en/latest/deployments/ack.md
diff --git a/docs/deployments/aws.md b/docs/en/latest/deployments/aws.md
similarity index 100%
rename from docs/deployments/aws.md
rename to docs/en/latest/deployments/aws.md
diff --git a/docs/deployments/azure.md b/docs/en/latest/deployments/azure.md
similarity index 100%
rename from docs/deployments/azure.md
rename to docs/en/latest/deployments/azure.md
diff --git a/docs/deployments/gke.md b/docs/en/latest/deployments/gke.md
similarity index 100%
rename from docs/deployments/gke.md
rename to docs/en/latest/deployments/gke.md
diff --git a/docs/deployments/k3s-rke.md b/docs/en/latest/deployments/k3s-rke.md
similarity index 100%
rename from docs/deployments/k3s-rke.md
rename to docs/en/latest/deployments/k3s-rke.md
diff --git a/docs/deployments/kubesphere.md b/docs/en/latest/deployments/kubesphere.md
similarity index 100%
rename from docs/deployments/kubesphere.md
rename to docs/en/latest/deployments/kubesphere.md
diff --git a/docs/deployments/minikube.md b/docs/en/latest/deployments/minikube.md
similarity index 100%
rename from docs/deployments/minikube.md
rename to docs/en/latest/deployments/minikube.md
diff --git a/docs/deployments/tke.md b/docs/en/latest/deployments/tke.md
similarity index 100%
rename from docs/deployments/tke.md
rename to docs/en/latest/deployments/tke.md
diff --git a/docs/design.md b/docs/en/latest/design.md
similarity index 95%
rename from docs/design.md
rename to docs/en/latest/design.md
index e58b7c8..a615464 100644
--- a/docs/design.md
+++ b/docs/en/latest/design.md
@@ -23,7 +23,7 @@ Apache APISIX ingress for Kubernetes.
 
 ## Modules
 
-![Architecture](./images/modules.png)
+![Architecture](../../assets/images/modules.png)
 
 ### 1.Ingress-types
 
@@ -71,11 +71,11 @@ Currently `apisix-ingress-controller` CRDs consist of 3 parts: ApisixRoute/Apisi
 
 ### Timing diagram
 
-![flow](./images/flow.png)
+![flow](../../assets/images/flow.png)
 
 * Here is a flowchart that introduces the main logic of `ApisixRoute` and other CRDs during synchronization.
 
-![logic](./images/sync-logic-controller.png)
+![logic](../../assets/images/sync-logic-controller.png)
 
 ### Conversion structure
 
@@ -85,7 +85,7 @@ Taking into account the usage habits of different groups of people, the data str
 
 A simple comparison is as follows, they have different definitions:
 
-![strut-compare](./images/struct-compare.png)
+![strut-compare](../../assets/images/struct-compare.png)
 
 They are a many-to-many relationship.Therefore, `apisix-ingress-controller` has to do some conversion of CRDs to adapt to different gateways.
 
@@ -95,7 +95,7 @@ At present, we have defined multiple CRDs, and these CRDs are responsible for th
 
 So, in `apisix-ingress-controller`, a broadcast notification mechanism is designed through `channel`, that is, the definition of any object must be notified to other objects related to it and trigger the corresponding behavior.
 
-![hierarchical](./images/cascade-update.png)
+![hierarchical](../../assets/images/cascade-update.png)
 
 **We can initiate discussions in this area and propose a more reasonable design plan**
 
@@ -105,7 +105,7 @@ The `seven` module internally saves memory data structures, which is currently v
 
 The current comparison rule is based on the grouping of `route` / `service` / `upstream` resource objects, compare them separately, and make corresponding broadcast notifications after finding the differences.
 
-![diff-flow](./images/diff-rules.png)
+![diff-flow](../../assets/images/diff-rules.png)
 
 ### Service Discovery
 
diff --git a/docs/development.md b/docs/en/latest/development.md
similarity index 100%
rename from docs/development.md
rename to docs/en/latest/development.md
diff --git a/docs/install.md b/docs/en/latest/install.md
similarity index 100%
rename from docs/install.md
rename to docs/en/latest/install.md
diff --git a/docs/samples/index.md b/docs/en/latest/samples/index.md
similarity index 100%
rename from docs/samples/index.md
rename to docs/en/latest/samples/index.md
diff --git a/docs/samples/proxy-the-httpbin-service-with-ingress.md b/docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md
similarity index 100%
rename from docs/samples/proxy-the-httpbin-service-with-ingress.md
rename to docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md
diff --git a/docs/samples/proxy-the-httpbin-service.md b/docs/en/latest/samples/proxy-the-httpbin-service.md
similarity index 100%
rename from docs/samples/proxy-the-httpbin-service.md
rename to docs/en/latest/samples/proxy-the-httpbin-service.md
diff --git a/docs/usage.md b/docs/en/latest/usage.md
similarity index 97%
rename from docs/usage.md
rename to docs/en/latest/usage.md
index 822c8da..79a887f 100644
--- a/docs/usage.md
+++ b/docs/en/latest/usage.md
@@ -27,7 +27,7 @@ Configure a simple routing rule through the ingress controller CRDs. After synch
 
 As shown below.
 
-![scene](./images/scene.png)
+![scene](../../assets/images/scene.png)
 
 ## A simple example
 
@@ -35,7 +35,7 @@ Define the simplest route to direct traffic to the back-end service, the back-en
 
 As shown below.(The ip list in nodes is an example, no specific meaning)
 
-![first](./images/first.png)
+![first](../../assets/images/first.png)
 
 Now we define with CRDs as follows.