You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/03/15 18:08:38 UTC
[GitHub] [pulsar] dave2wave opened a new issue #14696: [Doc] Avoid using external urls in the website
dave2wave opened a new issue #14696:
URL: https://github.com/apache/pulsar/issues/14696
### What issue do you find in Pulsar docs?
There are many examples in `site2/docs/*.md` of external links that ought to internal.
This makes new site architecture and staged new versions of the documentation VERY difficult to review.
Every doc md file needs to be reviewed.
You will find problems on pages with this issue in the next site.
### What is your suggestion?
For example in `concepts-messaging.md`
```
If the consumer fails to receive all chunks of a message within a specified time period, it expires incomplete chunks. The default value is 1 minute. For more information about the `expireTimeOfIncompleteChunkedMessage` parameter, refer to [org.apache.pulsar.client.api](https://pulsar.apache.org/api/client/).
```
is best done as
```
If the consumer fails to receive all chunks of a message within a specified time period, it expires incomplete chunks. The default value is 1 minute. For more information about the `expireTimeOfIncompleteChunkedMessage` parameter, refer to [org.apache.pulsar.client.api](/api/client/).
```
There are other issues on the new site that are related. Please visit https://pulsar-next.staged.apache.org/docs/next/concepts-messaging
### Do you have any references?
Pick almost any page in `site2/docs` and there will be url issues.
### Would you like to fix this issue?
This is a large effort. I'm willing to review results.
### Note
- [X] I have researched my question.
--
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: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] DaveDuggins commented on issue #14696: [Doc] Avoid using external urls in the website
Posted by GitBox <gi...@apache.org>.
DaveDuggins commented on issue #14696:
URL: https://github.com/apache/pulsar/issues/14696#issuecomment-1084733792
I'll be uploading many changes to this document very soon. Wait to fix
broken links until I update next week.
On Thu, Mar 31, 2022 at 4:52 AM Anonymitaet ***@***.***>
wrote:
> Closed #14696 <https://github.com/apache/pulsar/issues/14696> via #14938
> <https://github.com/apache/pulsar/pull/14938>.
>
> —
> Reply to this email directly, view it on GitHub
> <https://github.com/apache/pulsar/issues/14696#event-6341974654>, or
> unsubscribe
> <https://github.com/notifications/unsubscribe-auth/AWOUOD7DIGIUOJ5KRN5GBGDVCVRURANCNFSM5QZPVRCA>
> .
> You are receiving this because you were mentioned.Message ID:
> ***@***.***>
>
--
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: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet edited a comment on issue #14696: [Doc] Avoid using external urls in the website
Posted by GitBox <gi...@apache.org>.
Anonymitaet edited a comment on issue #14696:
URL: https://github.com/apache/pulsar/issues/14696#issuecomment-1068901568
@dave2wave thanks! We @urfreespace are investigating this issue.
I find other broken URLs, for example, below is a screenshot from https://pulsar-next.staged.apache.org/docs/next/concepts-messaging/, but the same URL on https://pulsar.apache.org/docs/en/next/concepts-messaging/ is OK
<img width="1016" alt="image" src="https://user-images.githubusercontent.com/50226895/158556363-d534dfda-96d4-4aee-93e0-1f96a1e12bf6.png">
@D-2-Ed @DaveDuggins @momo-jun we need to check all URLs before launching the new website. I've used an automation tool https://www.deadlinkchecker.com/ but the outcome is not good enough. Any thoughts？
--
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: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on issue #14696: [Doc] Avoid using external urls in the website
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #14696:
URL: https://github.com/apache/pulsar/issues/14696#issuecomment-1068901568
@dave2wave thanks! We @urfreespace are investigating this issue.
I find other broken URLs, for example, https://pulsar-next.staged.apache.org/docs/next/concepts-messaging/, but the same URL on https://pulsar.apache.org/docs/en/next/concepts-messaging/ is OK
<img width="1016" alt="image" src="https://user-images.githubusercontent.com/50226895/158556363-d534dfda-96d4-4aee-93e0-1f96a1e12bf6.png">
@D-2-Ed @DaveDuggins @momo-jun we need to check all URLs before launching the new website. I've used an automation tool https://www.deadlinkchecker.com/ but the outcome is not good enough. Any thoughts？
--
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: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet closed issue #14696: [Doc] Avoid using external urls in the website
Posted by GitBox <gi...@apache.org>.
Anonymitaet closed issue #14696:
URL: https://github.com/apache/pulsar/issues/14696
--
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: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org