You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/08/09 14:32:36 UTC
[GitHub] [apisix-java-plugin-runner] tzssangglass opened a new pull request, #182: docs: refactor multiple documentation structures
tzssangglass opened a new pull request, #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182
refactor multiple documentation structures to distinguish between installation, deployment, and feature support
Signed-off-by: tzssangglass <tz...@gmail.com>
Please answer these questions before submitting a pull request
- Why submit this pull request?
- [ ] Bugfix
- [ ] New feature provided
- [ ] Improve performance
- Related issues
___
### Bugfix
- Description
- How to fix?
___
### New feature or improvement
- Describe the details and related test reports.
- Source branch
- Related commits and pull requests
- Target branch
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r941927000
##########
docs/en/latest/config.json:
##########
@@ -12,6 +12,18 @@
{
"type": "doc",
"id": "the-internal-of-apisix-java-plugin-runner"
+ },
+ {
+ "type": "doc",
+ "id": "installation-guide"
+ },
+ {
+ "type": "doc",
+ "id": "deployment-guide"
+ },
+ {
+ "type": "doc",
Review Comment:
`config.json` is used to display sidebar on the official website, see: https://apisix.apache.org/docs/java-plugin-runner/development/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] nfrankel commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
nfrankel commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r941711468
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,45 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is working in process**
Review Comment:
This feature is a <abbr title="Work In Progress">WIP</abbr>
##########
docs/en/latest/installation-guide.md:
##########
@@ -0,0 +1,111 @@
+---
+title: Installation
+keywords:
+- apisix-java-plugin-runner
+- Installation
+ description: This document explains how to installation and use 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 document explains how to install apisix-java-plugin-runner.
+
+Prerequisites
+-------------
+
+* JDK 11
+* APISIX 2.15.0
+* Refer to [Debug](how-it-works.md#debug) to build the debug environment.
+
+Install
+-------
+
+1. Create a simple web application with Spring Boot, and choose Maven as the build tool.
+
+2. Add the GAV of `apisix-java-plugin-runner` in `pom.xml`, like:
+
+```xml
+<dependency>
+ <groupId>org.apache.apisix</groupId>
+ <artifactId>apisix-runner-starter</artifactId>
+ <version>${project.version}</version>
Review Comment:
`${project.version}` is the project POM's version, _i.e._, if my POM is `0.1-SNAPSHOT`, it will use this value. It seems highly suspect: I'd suggest to replace it with `0.3.0`. Even better, we could update the value to the current version at documentation's build time.
##########
docs/en/latest/config.json:
##########
@@ -12,6 +12,18 @@
{
"type": "doc",
"id": "the-internal-of-apisix-java-plugin-runner"
+ },
+ {
+ "type": "doc",
+ "id": "installation-guide"
+ },
+ {
+ "type": "doc",
+ "id": "deployment-guide"
+ },
+ {
+ "type": "doc",
Review Comment:
I'm not sure it's a good idea to add an empty document to the documentation
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,45 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is working in process**
+
+### Ship plugin
+
+In your plugin's *pom.xml*, add
Review Comment:
In which section? Could you detail the context around?
##########
docs/en/latest/installation-guide.md:
##########
@@ -0,0 +1,111 @@
+---
+title: Installation
+keywords:
+- apisix-java-plugin-runner
+- Installation
+ description: This document explains how to installation and use 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 document explains how to install apisix-java-plugin-runner.
+
+Prerequisites
+-------------
+
+* JDK 11
+* APISIX 2.15.0
+* Refer to [Debug](how-it-works.md#debug) to build the debug environment.
+
+Install
+-------
+
+1. Create a simple web application with Spring Boot, and choose Maven as the build tool.
+
+2. Add the GAV of `apisix-java-plugin-runner` in `pom.xml`, like:
Review Comment:
Add the Java Plugin runner dependency in your POM:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r941926708
##########
docs/en/latest/installation-guide.md:
##########
@@ -0,0 +1,111 @@
+---
+title: Installation
+keywords:
+- apisix-java-plugin-runner
+- Installation
+ description: This document explains how to installation and use 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 document explains how to install apisix-java-plugin-runner.
+
+Prerequisites
+-------------
+
+* JDK 11
+* APISIX 2.15.0
+* Refer to [Debug](how-it-works.md#debug) to build the debug environment.
+
+Install
+-------
+
+1. Create a simple web application with Spring Boot, and choose Maven as the build tool.
+
+2. Add the GAV of `apisix-java-plugin-runner` in `pom.xml`, like:
Review Comment:
done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r941926605
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,45 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is working in process**
Review Comment:
done
##########
docs/en/latest/installation-guide.md:
##########
@@ -0,0 +1,111 @@
+---
+title: Installation
+keywords:
+- apisix-java-plugin-runner
+- Installation
+ description: This document explains how to installation and use 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 document explains how to install apisix-java-plugin-runner.
+
+Prerequisites
+-------------
+
+* JDK 11
+* APISIX 2.15.0
+* Refer to [Debug](how-it-works.md#debug) to build the debug environment.
+
+Install
+-------
+
+1. Create a simple web application with Spring Boot, and choose Maven as the build tool.
+
+2. Add the GAV of `apisix-java-plugin-runner` in `pom.xml`, like:
+
+```xml
+<dependency>
+ <groupId>org.apache.apisix</groupId>
+ <artifactId>apisix-runner-starter</artifactId>
+ <version>${project.version}</version>
Review Comment:
done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r942121031
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
yes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] juzhiyuan commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943026929
##########
docs/en/latest/installation-guide.md:
##########
@@ -0,0 +1,111 @@
+---
+title: Installation
+keywords:
+- apisix-java-plugin-runner
+- Installation
+ description: This document explains how to installation and use apisix-java-plugin-runner.
Review Comment:
Hi, could you please add more descriptions to other docs? It's helpful on SEO :) (We will improve them of course, but need your help to provide the first version)
```suggestion
description: This document explains how to installation and use apisix-java-plugin-runner.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943062281
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
fixed
##########
docs/en/latest/installation-guide.md:
##########
@@ -0,0 +1,111 @@
+---
+title: Installation
+keywords:
+- apisix-java-plugin-runner
+- Installation
+ description: This document explains how to installation and use apisix-java-plugin-runner.
Review Comment:
fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r942121649
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
should we remove this docs or change the noto to: `This feature is WIP`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] SylviaBABY commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943031182
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
You can use this format, the effect is as follows
<img width="475" alt="image" src="https://user-images.githubusercontent.com/39793568/184048766-971d79e5-6618-4eba-bba8-8a21f46278ff.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943062399
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
fixed, many thanks
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
+
+### Ship plugin
+
+In your plugin's `pom.xml`, add
Review Comment:
done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r941927701
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
+
+### Ship plugin
+
+In your plugin's `pom.xml`, add
+```
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-maven-plugin</artifactId>
+ <configuration>
+ <classifier>exec</classifier>
+ </configuration>
+ </plugin>
+ </plugins>
+</build>
+```
Review Comment:
@ericluoliu Is it right here? about where `<classifier>exec</classifier>` is placed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] SylviaBABY commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943030227
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
```suggestion
:::note
This feature is a WIP.
:::
```
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
+
+### Ship plugin
+
+In your plugin's `pom.xml`, add
Review Comment:
```suggestion
In your plugin's `pom.xml`, add the following configuration:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] SylviaBABY commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943031182
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
You can use this format, the effect is as follows（If the website does not support this format, just ignore this)
<img width="475" alt="image" src="https://user-images.githubusercontent.com/39793568/184048766-971d79e5-6618-4eba-bba8-8a21f46278ff.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] ericluoliu commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
ericluoliu commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r941938810
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
+
+### Ship plugin
+
+In your plugin's `pom.xml`, add
+```
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-maven-plugin</artifactId>
+ <configuration>
+ <classifier>exec</classifier>
+ </configuration>
+ </plugin>
+ </plugins>
+</build>
+```
Review Comment:
@tzssangglass yes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] spacewander commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
spacewander commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r942064264
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
What does `this feature` mean? Does it mean deploying custom plugins is still WIP?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] spacewander commented on a diff in pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
spacewander commented on code in PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182#discussion_r943028985
##########
docs/en/latest/deployment-guide.md:
##########
@@ -0,0 +1,57 @@
+---
+title: Deployment 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 document explains how to support multiple ways to deploy custom plugins.
+
+**Note: This feature is a WIP**
Review Comment:
It's up to you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-java-plugin-runner] tzssangglass merged pull request #182: docs: refactor multiple documentation structures
Posted by GitBox <gi...@apache.org>.
tzssangglass merged PR #182:
URL: https://github.com/apache/apisix-java-plugin-runner/pull/182
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org