Skip to content

MINOR: Improve Connect docs #11642

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
showuon merged 2 commits into from
Feb 22, 2022
+182 −206
Merged

MINOR: Improve Connect docs #11642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e65c697
MINOR: Improve Connect docs
mimaison Jan 3, 2022
65f3394
Inline </pre> tags to avoid extra empty lines
mimaison Jan 4, 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
2 changes: 1 addition & 1 deletion connect/runtime/src/main/java/org/apache/kafka/connect/tools/PredicateDoc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ private static void printPredicateHtml(PrintStream out, DocInfo docInfo) {
out.println("<div id=\"" + docInfo.predicateName + "\">");

out.print("<h5>");
out.print(docInfo.predicateName);
out.print("<a href=\"#" + docInfo.predicateName + "\">" + docInfo.predicateName + "</a>");
Copy link
Copy Markdown
Member

@tombentley tombentley Feb 9, 2022

Choose a reason for hiding this comment

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

Are this really href not name? If so what are they linking to?

Copy link
Copy Markdown
Member Author

@mimaison mimaison Feb 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

It's linking to the existing <div id="..."> just above on line 61

Copy link
Copy Markdown
Member

@showuon showuon Feb 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Could you let me know where does these predicateName appear in the doc?
here? https://kafka.apache.org/documentation/#connect_predicates
And what will be the expected output? What hyperlink destination we expected to link to?

Thank you.

Copy link
Copy Markdown
Member Author

@mimaison mimaison Feb 22, 2022

Choose a reason for hiding this comment

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

Predicates are listed in this section: https://kafka.apache.org/documentation/#connect_predicates

Currently the names of predicates are listed but they are not links so we can't easily copy direct links to them.

Copy link
Copy Markdown
Member

@showuon showuon Feb 22, 2022

Choose a reason for hiding this comment

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

OK, I got it. You want to add an anchor point in each predicate and transformation. I see now. I've checked, there is already the HTML element id = predicate names and transformation names, so adding an anchor link with the name can link to the position. Looks good to me. Thanks for the explanation.

out.println("</h5>");

out.println(docInfo.overview);
Expand Down
2 changes: 1 addition & 1 deletion connect/runtime/src/main/java/org/apache/kafka/connect/tools/TransformationDoc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ private static void printTransformationHtml(PrintStream out, DocInfo docInfo) {
out.println("<div id=\"" + docInfo.transformationName + "\">");

out.print("<h5>");
out.print(docInfo.transformationName);
out.print("<a href=\"#" + docInfo.transformationName + "\">" + docInfo.transformationName + "</a>");
out.println("</h5>");

out.println(docInfo.overview);
Expand Down
Loading