This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-go-plugin-runner.git
The following commit(s) were added to refs/heads/master by this push:
new 78a554a docs: add framework (#19)
78a554a is described below
commit 78a554ab266faa0b0681d0d1512144c00ce82419
Author: 罗泽轩 <[email protected]>
AuthorDate: Tue Jul 6 14:36:36 2021 +0800
docs: add framework (#19)
---
docs/en/latest/config.json | 13 +++++++++++++
docs/en/latest/developer-guide.md | 35 +++++++++++++++++++++++++++++++++++
docs/en/latest/getting-started.md | 29 +++++++++++++++++++++++++++++
3 files changed, 77 insertions(+)
diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
new file mode 100644
index 0000000..4f0d229
--- /dev/null
+++ b/docs/en/latest/config.json
@@ -0,0 +1,13 @@
+{
+ "version": 0.1,
+ "sidebar": [
+ {
+ "type": "doc",
+ "id": "getting-started"
+ },
+ {
+ "type": "doc",
+ "id": "developer-guide"
+ }
+ ]
+}
diff --git a/docs/en/latest/developer-guide.md
b/docs/en/latest/developer-guide.md
new file mode 100644
index 0000000..ef8b71c
--- /dev/null
+++ b/docs/en/latest/developer-guide.md
@@ -0,0 +1,35 @@
+---
+title: Developer Guide
+---
+
+<!--
+#
+# 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 documentation explains how to develop this project.
+
+## Build
+
+Run `make build`. Then you can run
`APISIX_LISTEN_ADDRESS=unix:/tmp/runner.sock APISIX_CONF_EXPIRE_TIME=3600
./go-runner run`
+to start it.
+
+## Test
+
+Run `make test`.
diff --git a/docs/en/latest/getting-started.md
b/docs/en/latest/getting-started.md
new file mode 100644
index 0000000..6b1bd64
--- /dev/null
+++ b/docs/en/latest/getting-started.md
@@ -0,0 +1,29 @@
+---
+title: Getting started
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Prerequisites
+
+* Go (>= 1.15)
+* APISIX (>= 2.7.0)
+
+<!-- TODO -->
