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

Add document for API usage and examples #12

Open
yunfengzhou-hub opened this issue Jan 21, 2022 · 0 comments
Open

Add document for API usage and examples #12

yunfengzhou-hub opened this issue Jan 21, 2022 · 0 comments
Assignees

Comments

@yunfengzhou-hub
Copy link
Collaborator

Clink needs more documentation and examples about the usage of Clink APIs so as to improve Clink's readability and usability. It is equally important to setup conventions for the whole documentation system for Clink's infrastructure and operators.

Possible implementation details of this issue could be to

  • Add a docs/ folder containing markdown files of user guides
  • Add various Clink programs as examples
  • Add more detailed description directly to APIs, like Flink has done to org.apache.flink.table.api.Table.
@yunfengzhou-hub yunfengzhou-hub self-assigned this Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant