Skip to content

When generate doc, ignore the hidden parameters. #16298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Anonymitaet merged 3 commits into from
Jul 1, 2022
Merged

When generate doc, ignore the hidden parameters. #16298

Anonymitaet merged 3 commits into from
Jul 1, 2022

Conversation

@horizonzy
Copy link
Member

@horizonzy horizonzy commented Jun 30, 2022 •
edited by Anonymitaet
Loading

Fixes #15771

Documentation

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

@github-actions
Copy link

github-actions bot commented Jun 30, 2022

@horizonzy Please provide a correct documentation label for your PR.
Instructions see Pulsar Documentation Label Guide.

@github-actions github-actions bot added doc-not-needed Your PR changes do not impact docs and removed doc-label-missing labels Jun 30, 2022
@horizonzy
Copy link
Member Author

horizonzy commented Jun 30, 2022

@urfreespace pls check it, thanks.

@urfreespace
Copy link
Member

urfreespace commented Jun 30, 2022

@urfreespace pls check it, thanks.

pulsar-admin/pulsar-client/pulsar-perf/pulsar all need to be fixed, I think they are different cmd class file

@horizonzy
Copy link
Member Author

horizonzy commented Jun 30, 2022

Run pulsar-admin configFile documents generate functions at local.
Before this change output:
Before.txt

After this change output:
After.txt

@horizonzy
Copy link
Member Author

horizonzy commented Jun 30, 2022

@urfreespace pls check it, thanks.

pulsar-admin/pulsar-client/pulsar-perf/pulsar all need to be fixed, I think they are different cmd class file

Thanks your reminder, the new commit pushed.

@horizonzy
Copy link
Member Author

horizonzy commented Jun 30, 2022

@Anonymitaet @momo-jun Pls confirm shall we ignore the ServiceConfiguration deprecated param.

@urfreespace urfreespace requested a review from Anonymitaet June 30, 2022 08:17
horizonzy
horizonzy commented Jun 30, 2022
View reviewed changes
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java Outdated
for (Field field : fields) {
FieldContext fieldContext = field.getAnnotation(FieldContext.class);
if (fieldContext == null) {
if (fieldContext == null || fieldContext.deprecated()) {
Copy link
Member Author

@horizonzy horizonzy Jun 30, 2022

Choose a reason for hiding this comment

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

@urfreespace Pls help check this change, shall we ignore the FileContext.deprecated param.

Copy link
Member

@urfreespace urfreespace Jun 30, 2022

Choose a reason for hiding this comment

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

@Anonymitaet any idea? I think it's not a tech question

Copy link
Member

@Anonymitaet Anonymitaet Jun 30, 2022

Choose a reason for hiding this comment

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

@urfreespace I've discussed w/ @horizonzy, we'll use the parameter hidden to determine whether show a flag or not (and ignore the deprecated parameter). I'll huddle w/ u tmr.

@Anonymitaet Anonymitaet mentioned this pull request Jul 1, 2022
Closed
4 tasks
@github-actions github-actions bot added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-not-needed Your PR changes do not impact docs labels Jul 1, 2022
@Anonymitaet
Copy link
Member

Anonymitaet commented Jul 1, 2022

/pulsarbot run-failure-checks

1 similar comment
@Anonymitaet
Copy link
Member

Anonymitaet commented Jul 1, 2022

/pulsarbot run-failure-checks

@Anonymitaet Anonymitaet merged commit 8b5bdb3 into apache:master Jul 1, 2022
Nicklee007 pushed a commit to Nicklee007/pulsar that referenced this pull request Jul 5, 2022
@horizonzy
When generate doc, ignore the hidden parameters. (apache#16298)
b2d67b6
wuxuanqicn pushed a commit to wuxuanqicn/pulsar that referenced this pull request Jul 14, 2022
@horizonzy @weimob-wuxuanqi
When generate doc, ignore the hidden parameters. (apache#16298)
a1e3f4a
@sijie sijie mentioned this pull request Aug 7, 2022
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@urfreespace urfreespace urfreespace approved these changes

@Anonymitaet Anonymitaet Awaiting requested review from Anonymitaet

Assignees

@horizonzy horizonzy

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Doc] Auto-hide deprecated parameters in Pulsar admin CLI docs

3 participants

@horizonzy @urfreespace @Anonymitaet