You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "Arghyahub (via GitHub)" <gi...@apache.org> on 2023/05/13 09:17:40 UTC
[GitHub] [apisix] Arghyahub opened a new pull request, #9479: docs : Change broken links
Arghyahub opened a new pull request, #9479:
URL: https://github.com/apache/apisix/pull/9479
### Description
The links in the Prerequisites section of rate limiting were broken.
This PR takes `Get APISIX` link to the correct readme page
and takes `Configure Routes` to the correct configure-routes page
Fixes #9473
### 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
- [ ] 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)
--
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] Neilblaze commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Neilblaze (via GitHub)" <gi...@apache.org>.
Neilblaze commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1547684714
> ... `./` Works for accessing files in same directory but `../` doesn't work here
@Arghyahub This is because in VS code (i.e. in local) every URI in the markdown file is set at `relative path`, whereas, after deployment, it's set on `absolute` (concatenated) since it can access the directory tree of [apisix-website](https://github.com/apache/apisix-website) as previously highlighted by @Gallardot.
Push the requested changes, we'll review them if anything goes wrong :)
--
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] Arghyahub commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Arghyahub (via GitHub)" <gi...@apache.org>.
Arghyahub commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1546943467
I have fixed all the links.
I'm new to open source and want to provide more to the community, Your guidance will help me a lot to grow in this field.
Thank you for all you help and would like to gain more experience and give back as much as I can.
--
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] Arghyahub commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Arghyahub (via GitHub)" <gi...@apache.org>.
Arghyahub commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1547255458
Is there any way I can setup the frontend locally and test the site?
I have edited all files in VSCode and `./` Works for accessing files in same directory but `../` doesn't work here
--
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] Arghyahub commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Arghyahub (via GitHub)" <gi...@apache.org>.
Arghyahub commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1546938284
> LGTM! Thank you for your contribution!
Would love to contribute more to the project💖
--
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] Arghyahub commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Arghyahub (via GitHub)" <gi...@apache.org>.
Arghyahub commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1547253989
Hey @Gallardot I tried putting ../ instead of ./
But the links doesn't seem to be working with that
--
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] monkeyDluffy6017 merged pull request #9479: docs: fix broken links in documentation
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 merged PR #9479:
URL: https://github.com/apache/apisix/pull/9479
--
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] Gallardot commented on a diff in pull request #9479: fix: Fix broken links in documentation
Posted by "Gallardot (via GitHub)" <gi...@apache.org>.
Gallardot commented on code in PR #9479:
URL: https://github.com/apache/apisix/pull/9479#discussion_r1193251765
##########
docs/en/latest/getting-started/configure-routes.md:
##########
@@ -28,7 +28,7 @@ An upstream is a set of target nodes with the same work. It defines a virtual ho
## Prerequisite(s)
-1. Complete [Get APISIX](./) to install APISIX.
+1. Complete [Get APISIX](./README.md) to install APISIX.
Review Comment:
```suggestion
1. Complete [Get APISIX](../README) to install APISIX.
```
##########
docs/en/latest/getting-started/load-balancing.md:
##########
@@ -17,8 +17,8 @@ In this tutorial, you will create a route with two upstream services and enable
## Prerequisite(s)
-1. Complete [Get APISIX](./) to install APISIX.
-2. Understand APISIX [Route and Upstream](./configure-routes#whats-a-route).
+1. Complete [Get APISIX](./README.md) to install APISIX.
Review Comment:
```suggestion
1. Complete [Get APISIX](../README) to install APISIX.
```
##########
docs/en/latest/getting-started/key-authentication.md:
##########
@@ -48,8 +48,8 @@ Key authentication is a relatively simple but widely used authentication approac
### Prerequisite(s)
-1. Complete [Get APISIX](./) to install APISIX.
-2. Complete [Configure Routes](./configure-routes#whats-a-route).
+1. Complete [Get APISIX](./README.md) to install APISIX.
+2. Complete [Configure Routes](./configure-routes.md).
Review Comment:
```suggestion
2. Complete [Configure Routes](../configure-routes#what-is-a-route).
```
##########
docs/en/latest/getting-started/rate-limiting.md:
##########
@@ -23,8 +23,8 @@ In this tutorial, you will enable the `limit-count` plugin to set a rate limitin
## Prerequisite(s)
-1. Complete the [Get APISIX](./) step to install APISIX first.
-2. Complete the [Configure Routes](./configure-routes#whats-a-route) step.
+1. Complete the [Get APISIX](./README) step to install APISIX first.
Review Comment:
```suggestion
1. Complete the [Get APISIX](../README) step to install APISIX first.
```
##########
docs/en/latest/getting-started/key-authentication.md:
##########
@@ -77,7 +77,7 @@ You will receive an `HTTP/1.1 201 OK` response if the consumer was created succe
### Enable Authentication
-Inheriting the route `getting-started-ip` from [Configure Routes](./configure-routes), we only need to use the `PATCH` method to add the `key-auth` plugin to the route:
+Inheriting the route `getting-started-ip` from [Configure Routes](./configure-routes.md), we only need to use the `PATCH` method to add the `key-auth` plugin to the route:
Review Comment:
```suggestion
Inheriting the route `getting-started-ip` from [Configure Routes](../configure-routes), we only need to use the `PATCH` method to add the `key-auth` plugin to the route:
```
##########
docs/en/latest/getting-started/rate-limiting.md:
##########
@@ -23,8 +23,8 @@ In this tutorial, you will enable the `limit-count` plugin to set a rate limitin
## Prerequisite(s)
-1. Complete the [Get APISIX](./) step to install APISIX first.
-2. Complete the [Configure Routes](./configure-routes#whats-a-route) step.
+1. Complete the [Get APISIX](./README) step to install APISIX first.
+2. Complete the [Configure Routes](./configure-routes) step.
Review Comment:
```suggestion
2. Complete the [Configure Routes](../configure-routes#what-is-a-route) step.
```
##########
docs/en/latest/getting-started/load-balancing.md:
##########
@@ -17,8 +17,8 @@ In this tutorial, you will create a route with two upstream services and enable
## Prerequisite(s)
-1. Complete [Get APISIX](./) to install APISIX.
-2. Understand APISIX [Route and Upstream](./configure-routes#whats-a-route).
+1. Complete [Get APISIX](./README.md) to install APISIX.
+2. Understand APISIX [Route and Upstream](./configure-routes.md).
Review Comment:
```suggestion
2. Understand APISIX [Route and Upstream](../configure-routes#what-is-a-route).
```
##########
docs/en/latest/getting-started/key-authentication.md:
##########
@@ -48,8 +48,8 @@ Key authentication is a relatively simple but widely used authentication approac
### Prerequisite(s)
-1. Complete [Get APISIX](./) to install APISIX.
-2. Complete [Configure Routes](./configure-routes#whats-a-route).
+1. Complete [Get APISIX](./README.md) to install APISIX.
Review Comment:
```suggestion
1. Complete [Get APISIX](../README) to install APISIX.
```
--
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] jiangfucheng commented on pull request #9479: fix: Fix broken links in documentation
Posted by "jiangfucheng (via GitHub)" <gi...@apache.org>.
jiangfucheng commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1546916229
@Arghyahub Hi, some links in these pages have same issues, could you fix these together?
https://apisix.apache.org/docs/apisix/getting-started/configure-routes/
--
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] Arghyahub commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Arghyahub (via GitHub)" <gi...@apache.org>.
Arghyahub commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1546938573
Sure @jiangfucheng
--
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] Gallardot commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Gallardot (via GitHub)" <gi...@apache.org>.
Gallardot commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1547495561
> Is there any way I can setup the frontend locally and test the site?
> I have edited all files in VSCode and `./` Works for accessing files in same directory but `../` doesn't work here
@Arghyahub APISIX's document repository is automatically synced to the [apisix-website](https://github.com/apache/apisix-website) project to generate documents, which you can view here https://github.com/apache/apisix-website/tree/asf-site
--
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] Arghyahub commented on pull request #9479: fix: Fix broken links in documentation
Posted by "Arghyahub (via GitHub)" <gi...@apache.org>.
Arghyahub commented on PR #9479:
URL: https://github.com/apache/apisix/pull/9479#issuecomment-1547821212
Thanks @Neilblaze for guiding me😊
I'm implementing the requested changes
--
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