[feat][doc] Separate CLI docs for doc gen automation - #18051
Conversation
|
|
FYI: @SignorMercurio @urfreespace I've confirmed with @codelipenghui, So I'll remove |
| * [`pulsar-admin`](https://pulsar.apache.org/reference/#/latest/pulsar-admin/) | ||
| * [`pulsar`](https://pulsar.apache.org/reference/#/latest/pulsar/) | ||
| * [`pulsar-client`](https://pulsar.apache.org/reference/#/latest/pulsar-client/) | ||
| * [`pulsar-perf`](https://pulsar.apache.org/reference/#/latest/pulsar-perf/) |
There was a problem hiding this comment.
- We'd better use
/referencethanhttps://pulsar.apache.org/referencehere. - We should find a way to generate version part (
latest) so that when the next version become a stable version, it doesn't direct users to the latest reference pages.
There was a problem hiding this comment.
Perhaps we can use @pulsar:version@ magic var but I think it cannot be resolved as latest. Maybe @pulsar:docversion? But there will be an issue between latest and next. We should unify names here.
There was a problem hiding this comment.
We can change latest to next, but may not be able to use /reference as it may be parsed by Docusaurus as a markdown docs rather than an external link to another site.
There was a problem hiding this comment.
@SignorMercurio Let's do the first part.
I'm thinking of that you can directly move the docsify folder under website-next/static/ and we can preview the references pages also. You can give it a try. And perhaps several build logics should be modified.


This is part work of PIP 78: Generate Docs from Code Automatically
Docs in the green circle are updated manually and shown independently on https://pulsar.apache.org/reference/#/latest/, so do not care about the metadata in .md files.
Metadata example:
Documentation
doc