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/05/25 09:07:29 UTC
[GitHub] [apisix] LancCJ opened a new pull request, #7127: docs:update "plugin-develop"(#6743)
LancCJ opened a new pull request, #7127:
URL: https://github.com/apache/apisix/pull/7127
### Description
<!-- Please include a summary of the change and which issue is fixed. -->
<!-- Please also include relevant motivation and context. -->
When developing plug-ins, I didn't pay attention to the user-defined path of plug-ins, resulting in no plug-ins found during testing. The original document didn't clearly remind this directory structure.
The modified content is to add a path prompt description to the document file
Fixes # (6743)
### Checklist
- [✅] I have explained the need for this PR and the problem it solves
- [✅] I have explained the changes or the new features added to this PR
- [✅ ] I have added tests corresponding to this change
- [✅ ] I have updated the documentation to reflect this change
- [✅] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
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] SylviaBABY commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r882266149
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,11 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
Review Comment:
```suggestion
```
```
--
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] LancCJ commented on pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on PR #7127:
URL: https://github.com/apache/apisix/pull/7127#issuecomment-1138080572
...syntax verification error
--
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] SylviaBABY commented on pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on PR #7127:
URL: https://github.com/apache/apisix/pull/7127#issuecomment-1137042687
@LancCJ Thanks for your contribution!
And pls also check those parts to pass the Lint test
<img width="1037" alt="image" src="https://user-images.githubusercontent.com/39793568/170236371-b0d92285-eabc-4c42-9313-3679bb73af9b.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] hf400159 commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r881413772
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,7 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
+**Note：custom plugin root directory must exists `/apisix/plugins` subdirectory**
Review Comment:
```suggestion
:::note
custom plugin root directory must exists `/apisix/plugins` subdirectory.
:::
```
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,7 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
+**Note：custom plugin root directory must exists `/apisix/plugins` subdirectory**
Review Comment:
```suggestion
:::note
custom plugin root directory must exists `/apisix/plugins` subdirectory**
:::
```
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
I don't understand the meaning of this sentence, could you describe it in detail?
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
```suggestion
:::note
自定义插件根目录下必须存在 `/apisix/plugins` 的子目录。
:::
```
--
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] spacewander merged pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
spacewander merged PR #7127:
URL: https://github.com/apache/apisix/pull/7127
--
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] SylviaBABY commented on pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on PR #7127:
URL: https://github.com/apache/apisix/pull/7127#issuecomment-1138084078
> ...syntax verification error
Just fix the above comment to pass the Lint check
--
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] hf400159 commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r882231834
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,11 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+custom plugin root directory must exists `/apisix/plugins` subdirectory**
Review Comment:
Please refer to Chinese to modify the English document.
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,11 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+如果你需要自定义插件的目录，请在该目录下创建 `/apisix/plugins` 的子目录。
Review Comment:
```suggestion
如果你需要自定义插件的目录，请在该目录下创建一个 `/apisix/plugins` 子目录。
```
--
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] LancCJ commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r882266857
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,11 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+If you need to customize the directory of plugin, please create a subdirectory of `/apisix/plugins` under this directory.
+
+:::
Review Comment:
前面加个空格？
--
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] LancCJ commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r881422231
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
If the plug-in directory is user-defined, there must be a directory of '/ apifix / plugins' under the user-defined root directory, so that apifix can recognize the plug-in
--
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] LancCJ commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r881424792
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
感觉应该写: 插件自定义根目录下必须存在 `/apisix/plugins` 的子目录 @hf400159
--
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] SylviaBABY commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r882266265
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,11 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+If you need to customize the directory of plugin, please create a subdirectory of `/apisix/plugins` under this directory.
+
+:::
Review Comment:
```suggestion
:::note
If you need to customize the directory of plugin, please create a subdirectory of `/apisix/plugins` under this directory.
:::
```
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,11 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+如果你需要自定义插件的目录，请在该目录下创建 `/apisix/plugins` 的子目录。
Review Comment:
```suggestion
:::note
如果你需要自定义插件的目录，请在该目录下创建 `/apisix/plugins` 的子目录。
```
--
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] LancCJ commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r881422231
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
If the plug-in directory is user-defined, there must be a directory of '/ apifix / plugins' under the user-defined root directory, so that apifix can recognize the plug-in @hf400159
--
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] LancCJ commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r882248431
##########
docs/en/latest/plugin-develop.md:
##########
@@ -42,6 +42,11 @@ For example, you can create a directory structure like this:
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+custom plugin root directory must exists `/apisix/plugins` subdirectory**
Review Comment:
ok
--
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] LancCJ commented on pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on PR #7127:
URL: https://github.com/apache/apisix/pull/7127#issuecomment-1138006862
>
OK, I understand. I'll pay attention to syntax verification later
--
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] hf400159 commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r881628501
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
如果你需要自定义插件的目录，请在该目录下创建 `/apisix/plugins` 的子目录。
--
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] hf400159 commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r881628501
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,7 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+**注意：自定义插件根目录下必须存在 `/apisix/plugins` 的子目录**
Review Comment:
如果你需要自定义插件的目录，请在该目录下创建一个 `/apisix/plugins` 子目录。
--
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] LancCJ commented on a diff in pull request #7127: docs:update "plugin-develop"(#6743)
Posted by GitBox <gi...@apache.org>.
LancCJ commented on code in PR #7127:
URL: https://github.com/apache/apisix/pull/7127#discussion_r882243778
##########
docs/zh/latest/plugin-develop.md:
##########
@@ -41,6 +41,11 @@ Apache APISIX 提供了两种方式来添加新的功能。
│ └── plugins
│ └── 3rd-party.lua
```
+:::note
+
+如果你需要自定义插件的目录，请在该目录下创建 `/apisix/plugins` 的子目录。
Review Comment:
ok
--
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