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/07/18 01:53:33 UTC
[GitHub] [pulsar] momo-jun opened a new issue, #16637: PIP-190: Simplify documentation release and maintenance strategy (WIP)
momo-jun opened a new issue, #16637:
URL: https://github.com/apache/pulsar/issues/16637
- Status: Draft
- Author: momo-jun
- Pull Request: (Link to the main pull request to resolve this PIP)
- Mailing List discussion: (Link to the mailing list discussion)
- Release: (Which release includes this PIP)
The draft is WIP [here](https://docs.google.com/document/d/1PlT-lhOl-CeqcuuQVWG4fvomv6ucfQiIk-VYZi346pM/edit#) and will be elaborated on this page once it's finished.
## Motivation
## Goal
## Implementation
--
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.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1262999428
@Anonymitaet Thanks for your information! This makes many sense.
--
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] momo-jun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
momo-jun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1216052815
@Anonymitaet can you pls help update the release document and contribution guide? Both the new doc sets `2.8.x/2.9.x/2.10.x` and the new `versions` page are in place.
--
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 #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1216202419
@momo-jun sure, I'll do that and request your review.
--
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] momo-jun closed issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
momo-jun closed issue #16637: PIP-190: Simplify documentation release and maintenance strategy
URL: https://github.com/apache/pulsar/issues/16637
--
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] momo-jun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
momo-jun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1239055277
Closed the issue since the PIP has been implemented.
--
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] momo-jun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
momo-jun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1222005898
> Two placeholders `@pulsar:version@` and `@pulsar:version_number@` are widely used in a dozen of doc pages in terms of:
>
> * **Static text** - maybe add a tip/note to notify users to instantiate the version number.
> * **Links to REST APIs** - can we use the latest instance of X to generate REST APIs to serve the purpose? @urfreespace
> * **Links to Maven** - users can continue to select a specific version number there, which is not bad. Any better ideas?
Many thanks to @urfreespace for providing a resolution/patch to fix the issue, which covers all the above three categories.
--
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] tisonkun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1261613553
@momo-jun @Anonymitaet is it possible to name the doc version as `2.11` instead of `2.11.x` and ditto for the following new versions? I don't think it's a brand new proposal here but a `.x` brings unnecessary confusion from my perspective.
For example:
* https://hbase.apache.org/2.4/book.html
* https://nightlies.apache.org/flink/flink-docs-release-1.15/
I agree it's a good idea to merge patch releases into one URL since no significant changes would be made. I'm glad to know whether there're other projects using `.x` versions in the docs site and URL and see how it works.
--
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] tisonkun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1220357108
<img width="1039" alt="image" src="https://user-images.githubusercontent.com/18818196/185569364-96c07f2f-1eb5-4b01-bd36-8d691d4267fd.png">
One more fake: all these links to maven central are broken links due to we don't publish version exact `2.10.x`
--
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 #16637: PIP-190: Simplify documentation release and maintenance strategy (WIP)
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1186709516
Thanks for your contribution! I've left some comments, PTAL. Feel free to let me know if you have any concerns. 😊
--
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 #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1261646011
@tisonkun thank you!
🔹🔹🔹
Here are some similar cases to Pulsar (use `.x` in doc management and URL)
- [Kong docs](https://docs.konghq.com/mesh/1.8.x/)
<img width="1280" alt="image" src="https://user-images.githubusercontent.com/50226895/192919817-6eccba1f-680f-46c3-9be2-462d2f9029d5.png">
- [RocketMQ](https://rocketmq.apache.org/en/docs/4.x/)
<img width="1280" alt="image" src="https://user-images.githubusercontent.com/50226895/192919906-57b939c8-28b3-49ad-bbf5-fb6b08e812cc.png">
🔹🔹🔹
Here are some similar cases to Kafka (use `.x` in doc management but **not in URL**)
- [Kubesphere](https://v3-2.docs.kubesphere.io/docs/)
<img width="1280" alt="image" src="https://user-images.githubusercontent.com/50226895/192920081-82efb3ba-2b4a-41e6-9448-3701b583d9ce.png">
- [Docusaurus](https://v1.docusaurus.io/)
<img width="1356" alt="image" src="https://user-images.githubusercontent.com/50226895/192920257-d00de8a4-08fb-4678-8af3-40b6d667cda6.png">
🔹🔹🔹
I think `2.11.x` is OK since `.x` is commonly used and everyone may know the meaning at the 1st glance.
@D-2-Ed @DaveDuggins @momo-jun 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] momo-jun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
momo-jun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1220369466
@tisonkun Thanks for the finding. Maybe we can add a tip/note to notify users to instantiate the version number. Any better ideas?
The doc files with this issue include:
* client-libraries-java.md
* client-libraries-python.md
* deploy-bare-metal.md
* io-debezium-source.md
* io-cdc-debezium.md
* standalone.md
* getting-started-standalone.md
--
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] tisonkun commented on issue #16637: PIP-190: Simplify documentation release and maintenance strategy
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #16637:
URL: https://github.com/apache/pulsar/issues/16637#issuecomment-1220349317
Now we encounter a new issue that the version number is `2.10.x` so all the placeholder `@pulsar:version_number@` becomes `2.10.x`. It will generate some fake info:
<img width="1055" alt="image" src="https://user-images.githubusercontent.com/18818196/185567812-8dc88372-708a-4cf5-a89e-42554160bd15.png">
We only provide `2.10.0` or `2.10.1`, no `2.10.x`.
--
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