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/06/23 09:47:49 UTC
[apisix-java-plugin-runner] branch main updated: docs: refactored
directory and added config.json (#38)
This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/apisix-java-plugin-runner.git
The following commit(s) were added to refs/heads/main by this push:
new 3623f5d docs: refactored directory and added config.json (#38)
3623f5d is described below
commit 3623f5d5fa87011f3da1be445a7c20390d000bd6
Author: Ayush das <ay...@gmail.com>
AuthorDate: Wed Jun 23 15:17:44 2021 +0530
docs: refactored directory and added config.json (#38)
Co-authored-by: 琚致远 <ju...@apache.org>
---
.licenserc.yaml | 1 +
README.md | 8 +++---
.../images/apisix-java-plugin-runner-overview.png | Bin
.../the-internal-of-apisix-java-plugin-runner.png | Bin
docs/en/latest/config.json | 17 +++++++++++++
docs/{ => en/latest}/development.md | 25 ++++++++++++++++++-
docs/{ => en/latest}/how-it-works.md | 25 ++++++++++++++++++-
.../the-internal-of-apisix-java-plugin-runner.md | 27 +++++++++++++++++++--
8 files changed, 95 insertions(+), 8 deletions(-)
diff --git a/.licenserc.yaml b/.licenserc.yaml
index 2012c56..37f7a4d 100644
--- a/.licenserc.yaml
+++ b/.licenserc.yaml
@@ -28,5 +28,6 @@ header:
- '.mvn'
- '**/target/**'
- '**/*.iml'
+ - 'docs/**/**/config.json'
comment: on-failure
diff --git a/README.md b/README.md
index 8f63e54..d68789c 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ apisix-java-plugin-runner
Runs [Apache APISIX](http://apisix.apache.org/) plugins written in Java.
Implemented as a sidecar that accompanies APISIX.
-
+
Status
------
@@ -27,21 +27,21 @@ this project is APISIX Java side implementation that supports writing plugins in
How it Works
-------------
-See [How it Works](./docs/how-it-works.md) to learn how apisix-java-plugin-runner collaborate
+See [How it Works](./docs/en/latest/how-it-works.md) to learn how apisix-java-plugin-runner collaborate
with APISIX to run plugins written in java.
The Internal of apisix-java-plugin-runner
---------------------------------
If you're interested in the internal of apisix-java-plugin-runner, we recommend you
-to read the [the-internal-of-apisix-java-plugin-runner](./docs/the-internal-of-apisix-java-plugin-runner.md),
+to read the [the-internal-of-apisix-java-plugin-runner](./docs/en/latest/the-internal-of-apisix-java-plugin-runner.md),
it explains the details of communication and protocol conversion with APISIX.
Get Involved in Development
---------------------------
Welcome to make contributions, but before you start, please check out
-[development.md](./docs/development.md) to learn how to run and debug apisix-java-plugin-runner
+[development.md](./docs/en/latest/development.md) to learn how to run and debug apisix-java-plugin-runner
in your own environment.
License
diff --git a/docs/images/apisix-java-plugin-runner-overview.png b/docs/assets/images/apisix-java-plugin-runner-overview.png
similarity index 100%
rename from docs/images/apisix-java-plugin-runner-overview.png
rename to docs/assets/images/apisix-java-plugin-runner-overview.png
diff --git a/docs/images/the-internal-of-apisix-java-plugin-runner.png b/docs/assets/images/the-internal-of-apisix-java-plugin-runner.png
similarity index 100%
rename from docs/images/the-internal-of-apisix-java-plugin-runner.png
rename to docs/assets/images/the-internal-of-apisix-java-plugin-runner.png
diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
new file mode 100644
index 0000000..eb6af5a
--- /dev/null
+++ b/docs/en/latest/config.json
@@ -0,0 +1,17 @@
+{
+ "version": 0.1,
+ "sidebar": [
+ {
+ "type": "doc",
+ "id": "development"
+ },
+ {
+ "type": "doc",
+ "id": "how-it-works"
+ },
+ {
+ "type": "doc",
+ "id": "the-internal-of-apisix-java-plugin-runner"
+ }
+ ]
+ }
diff --git a/docs/development.md b/docs/en/latest/development.md
similarity index 78%
rename from docs/development.md
rename to docs/en/latest/development.md
index e216226..f2eaccb 100644
--- a/docs/development.md
+++ b/docs/en/latest/development.md
@@ -1,4 +1,27 @@
-# Development
+---
+title: Development
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## Overview
This document explains how to get started to develop the apisix-java-plugin-runner.
diff --git a/docs/how-it-works.md b/docs/en/latest/how-it-works.md
similarity index 78%
rename from docs/how-it-works.md
rename to docs/en/latest/how-it-works.md
index 834b720..f004415 100644
--- a/docs/how-it-works.md
+++ b/docs/en/latest/how-it-works.md
@@ -1,4 +1,27 @@
-# How It Works
+---
+title: How it works
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## Overview
This article explains how apisix-java-plugin-runner collaborate with [Apache APISIX](https://apisix.apache.org) to run plugins written in java.
diff --git a/docs/the-internal-of-apisix-java-plugin-runner.md b/docs/en/latest/the-internal-of-apisix-java-plugin-runner.md
similarity index 67%
rename from docs/the-internal-of-apisix-java-plugin-runner.md
rename to docs/en/latest/the-internal-of-apisix-java-plugin-runner.md
index f9ea032..f178157 100644
--- a/docs/the-internal-of-apisix-java-plugin-runner.md
+++ b/docs/en/latest/the-internal-of-apisix-java-plugin-runner.md
@@ -1,4 +1,27 @@
-# The Internal of apisix java plugin runner
+---
+title: The internal of apisix java plugin runner
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## Overview
This article explains the internal design of apisix-java-plugin-runner.
@@ -18,7 +41,7 @@ Users only need to focus on their business logic, not on the details of how the
The inter-process communication between them is depicted by the following diagram.
-
+
## Communication