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/05/27 08:55:12 UTC
[GitHub] [pulsar] MarvinCai opened a new issue, #15813: [Doc] [New Website]
MarvinCai opened a new issue, #15813:
URL: https://github.com/apache/pulsar/issues/15813
### What issue do you find in Pulsar docs?
Many CLI commands are missing from new website
e.g. the command to trigger offload on topic is missing:
it's there on old website but missing from new website
<img width="1688" alt="image" src="https://user-images.githubusercontent.com/13480084/170665883-dc43f80f-f0be-4339-bc3f-b92405afa77d.png">
Also on new website CLI command no longer have detailed options explained,
take `pulsar-admin topics set-offload-policies options` as an example
on old website it lists each option:
<img width="1723" alt="image" src="https://user-images.githubusercontent.com/13480084/170666243-610feeb6-0ebc-470e-95fa-dd2c91bf150f.png">
while on new website it simply says there're options, but doesn't tell users what are the options
<img width="1451" alt="image" src="https://user-images.githubusercontent.com/13480084/170666362-9ca4830e-4b6c-4caa-81a0-864a1e96dacb.png">
### What is your suggestion?
CLI command doc on new website should provide same level of detail as old one.
### Do you have any references?
https://pulsar.apache.org/tools/pulsar-admin/2.10.0-SNAPSHOT/#-em-offload-em-
https://pulsar.apache.org/tools/pulsar-admin/2.10.0-SNAPSHOT/#-em-set-offload-policies-em--88
### Would you like to fix this issue?
N/A
### 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.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] michaeljmarshall commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1139703407
I think this is a function of how the docs are generated. It's also relevant that these docs are generated as `-SNAPSHOT` docs. Ideally, the docs would be generated as part of each release.
I found that the `bookies` sub-command was missing last week. I tried to fix it here https://github.com/apache/pulsar-site/pull/80. However, either the new docs haven't been built or there is another place that needs fixing.
Related issues: https://github.com/apache/pulsar/issues/14987 https://github.com/apache/pulsar/issues/14946 https://github.com/apache/pulsar/issues/14838 https://github.com/apache/pulsar/issues/13916
--
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 #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1338984686
Closed. I think we have a new reference page now: https://pulsar.apache.org/reference/
--
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] MarvinCai commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
MarvinCai commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1157624454
isn't new website suppose to make UX better?
--
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 #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1146969419
Docs are generated from code files as HTML pages (as below) rather than manually maintained in .md files, which is a more efficient and scalable way.
- https://pulsar.apache.org/tools/pulsar-admin/
- https://pulsar.apache.org/api/
- https://pulsar.apache.org/admin-rest-api/?version=master
--
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] dave2wave commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
dave2wave commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1146667941
> Admin API chapter is not actively maintained.
@Anonymitaet - Who made the decision to stop maintaining this chapter?
--
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] dave2wave commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
dave2wave commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1146667458
I agree with @MarvinCai - this is an incomplete part of the new website. These issues may require a more general discussion on the dev@pulsar mailing list so that we can find consensus on (a) the most important parts to complete, and (b) the best approach to fixing the issues. One thing for sure the problems here would not be as critical if site search was fixed.
--
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 #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1140608462
@MarvinCai
`Admin API` chapter is not actively maintained. This important notice was added previously (and might need to be shown more prominent). Please click the link in the red circle.
<img width="1521" alt="image" src="https://user-images.githubusercontent.com/50226895/170904533-5914cc0e-5745-4cc6-bfb2-cc7cf52be8fd.png">
/cc @momo-jun @D-2-Ed @DaveDuggins
--
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] MarvinCai commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
MarvinCai commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1140902101
that's just so weird that part of the doc are migrated but part of them are not, this is not good UX IMO.
--
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] dave2wave commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
dave2wave commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1159122950
I also find the generated documents to be scattered and unsorted and dependent on good code comments.
Doc writers are not coders. Coders tend to always check the "no need docs" button. A hand written md file will provide examples and appropriate use. These can be written in proper English and translated if there is effort.
--
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 #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1158579307
The website shows complete info containing flags
https://pulsar.apache.org/tools/pulsar-admin/2.11.0-SNAPSHOT/#-em-set-offload-policies-em--88
<img width="1284" alt="image" src="https://user-images.githubusercontent.com/50226895/174248087-5409f3a5-6871-4763-8dbf-9f771ee97d70.png">
--
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 closed issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
tisonkun closed issue #15813: [Doc] [New Website]
URL: https://github.com/apache/pulsar/issues/15813
--
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] dave2wave commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
dave2wave commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1159119542
The bad UX is here: https://pulsar.apache.org/tools/pulsar-admin/
--
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] MarvinCai commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
MarvinCai commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1157623443
I think no matter how we maintain the doc, current status is we have incomplete info here, user following just this doc can't use the commands, like `pulsar-admin topics set-offload-policies` I mentioned, what options should they put in the command?
--
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] github-actions[bot] commented on issue #15813: [Doc] [New Website]
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #15813:
URL: https://github.com/apache/pulsar/issues/15813#issuecomment-1186693276
The issue had no activity for 30 days, mark with Stale label.
--
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