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

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

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

   @michaeljmarshall 
   
   > In my opinion, these next docs are confusing to users since they document features that are not yet released.
   > I don't really think we should be exposing the unreleased configuration documentation for the current master branch on the pulsar.apache.org website.
   
   I think it's OK to show the `latest` docs. Reasons:
   
   1. 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`.
   
   Examples:
   - https://chaos-mesh.org/docs/next/
   - https://cassandra.apache.org/doc/latest/
   - https://docs.taichi-lang.org/docs/master/
   - https://skywalking.apache.org/docs/main/latest/en/concepts-and-designs/overview/
   
   2. 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.


-- 
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: dev-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org