[GitHub] [pulsar-site] michaeljmarshall commented on pull request #176: Generate client config docs from source code

[GitBox <gi...@apache.org>]

michaeljmarshall commented on PR #176:
URL: https://github.com/apache/pulsar-site/pull/176#issuecomment-1238913866

   Thanks for your explanation @Anonymitaet.
   
   > It may not cause confusion since many projects follow this way (as below). Users get used to it and they know the meaning of `latest`.
   
   I thought `latest` pointed to the "latest official release", and that the value of using `latest` is that your link will always point to the current latest release. For example, in the Cassandra link you shared, the right side shows that the docs are for version 4.1, even though the URL uses `latest`. In the drop down menu, it lets you select `master`, `trunk`, and several other versions. The Chaos Mesh website seems to use `next` to mean `master`, just like the Pulsar website, but the Chaos Mesh page warns users with a banner stating `This is unreleased documentation for Chaos Mesh Next version.`.
   
   > Pulsar documentation and website iterate fast and those changes are shown on `latest`. It's a good chance for users to capture fresh updates and for maintainers to promote new changes.
   
   I agree that it is helpful to give contributors a way to view their contributions, and I will modify what I said earlier about not putting that content on the website. It's okay to put it on the website, but I think we should make it clear that it is based on `master` version, which is not released yet. Thanks!


-- 
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