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/04/19 08:23:26 UTC
[GitHub] [apisix] gdsghost opened a new pull request, #6881: fixed plugin concept link in README
gdsghost opened a new pull request, #6881:
URL: https://github.com/apache/apisix/pull/6881
### Description
<!-- Please include a summary of the change and which issue is fixed. -->
<!-- Please also include relevant motivation and context. -->
Fixes #6880
### Checklist
- [x] I have explained the need for this PR and the problem it solves
- [x] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [x] I have updated the documentation to reflect this change
- [x] 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] spacewander commented on a diff in pull request #6881: fixed plugin concept link in README
Posted by GitBox <gi...@apache.org>.
spacewander commented on code in PR #6881:
URL: https://github.com/apache/apisix/pull/6881#discussion_r853677259
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
Could we add some link linter?
CC @navendu-pottekkat
--
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] navendu-pottekkat commented on a diff in pull request #6881: fixed plugin concept link in README
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #6881:
URL: https://github.com/apache/apisix/pull/6881#discussion_r853732391
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
We can add link linter but since pages are across multiple repos, it would be difficult to do it statically.
--
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] navendu-pottekkat commented on a diff in pull request #6881: fixed plugin concept link in README
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #6881:
URL: https://github.com/apache/apisix/pull/6881#discussion_r853765224
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
I did not realise that this was a change in README. For this case, a linter in GitHub workflows should work. There should be some action available that we can use.
For APISIX documentation, we have multiple repos and documentation for each of the components are in different repos. This is pulled in the apisix-website repo during a build. So, pages could be linked across repos and I don't think we can have static lint checks to catch them. We may need to build the website and test the links from the built website using some workflow.
--
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] gdsghost commented on a diff in pull request #6881: fixed plugin concept link in README
Posted by GitBox <gi...@apache.org>.
gdsghost commented on code in PR #6881:
URL: https://github.com/apache/apisix/pull/6881#discussion_r853756602
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
Can't we add linter in github workflows.
May I know the meaning of availability of pages on multiple repos?
CC @navendu-pottekkat
--
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 #6881: fixed plugin concept link in README
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #6881:
URL: https://github.com/apache/apisix/pull/6881#discussion_r853176803
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
`plugin.md` has moved to `terminology`.
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
```suggestion
Reading [plugin concept](docs/en/latest/terminology/plugin.md) would help you learn more about the plugin.
```
--
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] SkyeYoung commented on a diff in pull request #6881: fixed plugin concept link in README
Posted by GitBox <gi...@apache.org>.
SkyeYoung commented on code in PR #6881:
URL: https://github.com/apache/apisix/pull/6881#discussion_r855747183
##########
README.md:
##########
@@ -184,7 +184,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
4. Plugin development
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
- Reading [plugin concept](docs/en/latest/architecture-design/plugin.md) would help you learn more about the plugin.
+ Reading [plugin concept](docs/en/latest/architecture-design/apisix.md) would help you learn more about the plugin.
Review Comment:
> I did not realise that this was a change in README. For this case, a linter in GitHub workflows should work. There should be some action available that we can use.
>
> For APISIX documentation, we have multiple repos and documentation for each of the components are in different repos. This is pulled in the apisix-website repo during a build. So, pages could be linked across repos and I don't think we can have static lint checks to catch them. We may need to build the website and test the links from the built website using some workflow.
@navendu-pottekkat We already have one, pls see https://github.com/apache/apisix-website/issues/1047.
--
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 #6881: docs: update plugin concept link in README
Posted by GitBox <gi...@apache.org>.
spacewander merged PR #6881:
URL: https://github.com/apache/apisix/pull/6881
--
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