Skip to content
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

Merged
merged 5 commits into from
Dec 25, 2024

Conversation

bwcxyk
Copy link
Contributor

@bwcxyk bwcxyk commented Dec 25, 2024

  • 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.

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

- 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.
Copy link
Member

@Hisoka-X Hisoka-X left a 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

?

@bwcxyk
Copy link
Contributor Author

bwcxyk commented Dec 25, 2024

Thanks @bwcxyk ! Could you add a test case to check all docs in

?

I can't finish.

@bwcxyk
Copy link
Contributor Author

bwcxyk commented Dec 25, 2024

Use admonitions to highlight important information.

1 similar comment
@bwcxyk
Copy link
Contributor Author

bwcxyk commented Dec 25, 2024

Use admonitions to highlight important information.

@Hisoka-X
Copy link
Member

Please update

label: 'Contribution',

@hailin0 hailin0 merged commit 9f02943 into apache:dev Dec 25, 2024
5 checks passed
Copy link
Contributor

@davidzollo davidzollo left a comment

Choose a reason for hiding this comment

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

+1
good job

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants