Skip to content

[feat][doc] Separate CLI docs for doc gen automation - #18051

Merged
Anonymitaet merged 2 commits into
apache:masterfrom
Anonymitaet:10142
Oct 17, 2022
Merged

[feat][doc] Separate CLI docs for doc gen automation#18051
Anonymitaet merged 2 commits into
apache:masterfrom
Anonymitaet:10142

Conversation

@Anonymitaet

Copy link
Copy Markdown
Member

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.

image

Metadata example:

---
id: reference-cli-pulsar-shell
title: Pulsar CLI tools - pulsar-shell
sidebar_label: "cli-pulsar-shell"
---

Documentation

  • doc

@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Oct 14, 2022
@Anonymitaet Anonymitaet added this to the 2.11.0 milestone Oct 14, 2022
@Anonymitaet

Copy link
Copy Markdown
Member Author

@SignorMercurio

  1. Could you please review this PR from a technical perspective? Thank you!

  2. Once this PR gets merged, we need to show the content (in the green box) on https://pulsar.apache.org/reference/#/latest/ ASAP? Or else users can not see them

cc @D-2-Ed @DaveDuggins

@Anonymitaet

Copy link
Copy Markdown
Member Author

FYI: @SignorMercurio @urfreespace

I've confirmed with @codelipenghui, broker-tool is moved to pulsar-admin broker-stats

image

So I'll remove reference-cli-broker-tool.md, which means this section will not be available on the Reference site.
image

Comment on lines +9 to +12
* [`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/)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. We'd better use /reference than https://pulsar.apache.org/reference here.
  2. 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. ready-to-test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants