-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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.
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
[Fix][Doc] fix doc tip style and add document format specification #8378
Conversation
- Added a new note section in the document format specification, including tips, notes, and cautions. - Update the use of comments in Clickhouse, Hive, and LocalFile connector documentation. - Added a note section in the Chinese version of the document format specification.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @bwcxyk ! Could you add a test case to check all docs in
seatunnel/seatunnel-ci-tools/src/test/java/org/apache/seatunnel/api/file/MarkdownTest.java
Line 36 in bd89d84
public class MarkdownTest { |
I can't finish. |
Use admonitions to highlight important information. |
1 similar comment
Use admonitions to highlight important information. |
Please update Line 229 in bd89d84
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
good job
Purpose of this pull request
This pull request fix doc tip style.
Does this PR introduce any user-facing change?
no
How was this patch tested?
exists tests
Check list
New License Guide
release-note
.