Skip to content

[fix][docs] Remove redudant steps in docs gen #18132

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

Merged
merged 7 commits into from
Oct 24, 2022
Merged

[fix][docs] Remove redudant steps in docs gen #18132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3af695d
ci: remove redundant markdown list in CLI docs gen steps
SignorMercurio Oct 19, 2022
e59d36b
docs: use markdown file for reference-configuration instead of links
SignorMercurio Oct 19, 2022
13ea2a4
ci: remove redundant markdown list in CLI docs gen steps for pulsar-c…
SignorMercurio Oct 19, 2022
c1e22c6
docs: remove unused leading warning
SignorMercurio Oct 19, 2022
b98a250
reword
SignorMercurio Oct 19, 2022
7cffa57
docs: remove reference-cli-tools-*.md
SignorMercurio Oct 20, 2022
4bce553
Update site2/docs/reference-configuration.md
SignorMercurio Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,6 @@ private void generateDocument(StringBuilder sb, String module, JCommander obj) {
.append("\n```");
sb.append("\n\n");
CmdBase cmdObj = (CmdBase) obj.getObjects().get(0);
for (String s : cmdObj.jcommander.getCommands().keySet()) {
sb.append("* `").append(s).append("`\n");
}
Comment on lines -110 to -112
Copy link
Member

Choose a reason for hiding this comment

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

Could you share a preview of diff how these lines affect the final result?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

These lists are removed by removing these code. They are redundant because we now already have a TOC on the right side.

cmdObj.jcommander.getCommands().forEach((subK, subV) -> {
sb.append("\n\n## <em>").append(subK).append("</em>\n\n");
sb.append(cmdObj.getUsageFormatter().getCommandDescription(subK)).append("\n\n");
Expand Down
3 changes: 0 additions & 3 deletions pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ protected String generateDocument(String module, JCommander parentCmd) {
.append("$ pulsar-client ").append(module).append(" [options]")
.append("\n```");
sb.append("\n\n");
for (String s : cmd.getCommands().keySet()) {
sb.append("* `").append(s).append("`\n");
}
sb.append("|Flag|Description|Default|\n");
sb.append("|---|---|---|\n");
List<ParameterDescription> options = cmd.getParameters();
Expand Down
15 changes: 2 additions & 13 deletions pulsar-common/src/main/java/org/apache/pulsar/common/util/BaseGenerateDocumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,6 @@ protected void writeDocListByFieldContext(List<Pair<Field, FieldContextWrapper>>
final Field field = fieldPair.getKey();
field.setAccessible(true);


sb.append("### ").append(field.getName()).append("\n");
sb.append(fieldContext.doc().replace(">", "\\>")).append("\n\n");
sb.append("**Type**: `").append(field.getType().getCanonicalName()).append("`\n\n");
Expand Down Expand Up @@ -187,12 +186,6 @@ public int compare(Pair<Field, FieldContextWrapper> o1, Pair<Field, FieldContext
}
}

protected String prefix = "\n"
+ "!> This page is automatically generated from code files.\n"
+ "If you find something inaccurate, feel free to update `";
protected String suffix = "\n`.\n";


protected String generateDocByFieldContext(String className, String type, StringBuilder sb) throws Exception {
Class<?> clazz = Class.forName(className);
Object obj = clazz.getDeclaredConstructor().newInstance();
Expand All @@ -214,10 +207,7 @@ protected String generateDocByFieldContext(String className, String type, String
List<Pair<Field, FieldContextWrapper>> deprecatedFields =
fieldList.stream().filter(p -> p.getValue().deprecated()).collect(Collectors.toList());


sb.append("# ").append(type).append("\n");

sb.append(prefix).append(className).append(suffix);
sb.append("# ").append(type).append("\n\n");
sb.append("## Required\n");
writeDocListByFieldContext(requiredFields, sb, obj);
sb.append("## Optional\n");
Expand All @@ -239,8 +229,7 @@ protected String generateDocByApiModelProperty(String className, String type, St
List<Field> requiredFields = fieldList.stream().filter(isRequiredApiModel).collect(Collectors.toList());
List<Field> optionalFields = fieldList.stream().filter(isOptionalApiModel).collect(Collectors.toList());

sb.append("# ").append(type).append("\n");
sb.append(prefix).append(className).append(suffix);
sb.append("# ").append(type).append("\n\n");
sb.append("## Required\n");
writeDocListByApiModel(requiredFields, sb, obj);
sb.append("## Optional\n");
Expand Down
6 changes: 0 additions & 6 deletions pulsar-common/src/main/java/org/apache/pulsar/common/util/CmdGenerateDocs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,6 @@ private String generateDocument(String module, JCommander commander) {
&& cmd.getObjects().get(0).getClass().getName().equals("com.beust.jcommander.JCommander")) {
JCommander cmdObj = (JCommander) cmd.getObjects().get(0);
sb.append(" subcommand").append("\n```").append("\n\n");
for (String s : cmdObj.getCommands().keySet()) {
if (s.equals(name)) {
continue;
}
sb.append("* `").append(s).append("`\n");
}
cmdObj.getCommands().forEach((subK, subV) -> {
if (!subK.equals(name)) {
sb.append("\n\n## <em>").append(subK).append("</em>\n\n");
Expand Down
3 changes: 0 additions & 3 deletions pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,6 @@ private static String generateDocument(String module, JCommander parentCmd) {
.append("$ pulsar-perf ").append(module).append(" [options]")
.append("\n```");
sb.append("\n\n");
for (String s : cmd.getCommands().keySet()) {
sb.append("* `").append(s).append("`\n");
}
sb.append("|Flag|Description|Default|\n");
sb.append("|---|---|---|\n");
List<ParameterDescription> options = cmd.getParameters();
Expand Down
106 changes: 0 additions & 106 deletions site2/docs/reference-cli-bookkeeper.md
View file
Open in desktop

This file was deleted.

36 changes: 0 additions & 36 deletions site2/docs/reference-cli-broker-tool.md
View file
Open in desktop

This file was deleted.

48 changes: 0 additions & 48 deletions site2/docs/reference-cli-pulsar-daemon.md
View file
Open in desktop

This file was deleted.

Loading