[fix][docs] Remove redudant steps in docs gen - #18132
Conversation
Signed-off-by: Mercurio <signormercurio@gmail.com>
Signed-off-by: Mercurio <signormercurio@gmail.com>
…lient,pulsar,pulsar-perf Signed-off-by: Mercurio <signormercurio@gmail.com>
Signed-off-by: Mercurio <signormercurio@gmail.com>
github-actions
Bot
added
the
doc
Signed-off-by: Mercurio <signormercurio@gmail.com>
|
LGTM PTAL @urfreespace @tisonkun thanks! |
tisonkun
left a comment
tisonkun
left a comment
There was a problem hiding this comment.
Thanks for your contribution! Comments inline.
| "reference-cli-tools", | ||
| { | ||
| "type": "link", | ||
| "href": "https://pulsar.apache.org/reference", | ||
| "label": "Pulsar configuration" | ||
| }, | ||
| "reference-configuration", |
There was a problem hiding this comment.
After #18101, I think both "reference-cli-tools" and this new "reference-configuration" page redirect to http://pulsar.apache.org/reference?
But we can improve the docsify side later...
There was a problem hiding this comment.
@Anonymitaet suggests that we should make it a Markdown page instead of a direct link, so it's changed back here.
| for (String s : cmdObj.jcommander.getCommands().keySet()) { | ||
| sb.append("* `").append(s).append("`\n"); | ||
| } |
There was a problem hiding this comment.
Could you share a preview of diff how these lines affect the final result?
There was a problem hiding this comment.
These lists are removed by removing these code. They are redundant because we now already have a TOC on the right side.
Co-authored-by: tison <wander4096@gmail.com>
|
@SignorMercurio feel free to ping me to merge if all tests pass. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #18132 +/- ##
=============================================
+ Coverage 34.91% 45.99% +11.08%
- Complexity 5707 17667 +11960
=============================================
Files 607 1574 +967
Lines 53396 128502 +75106
Branches 5712 14144 +8432
=============================================
+ Hits 18644 59107 +40463
- Misses 32119 63283 +31164
- Partials 2633 6112 +3479
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
/pulsarbot run-failure-checks |
|
/pulsarbot run-failure-checks |
6 participants
Motivation
There are some redundant information in current pulsar docs, as pointed out by @Anonymitaet. This PR aims to fix those.
Modifications
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: SignorMercurio#5