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

Jump to bottom

[FEATURE] Improve development documentation #1219

Open

1 of 5 tasks

dai-chen opened this issue Jan 3, 2023 · 0 comments

Open

1 of 5 tasks

[FEATURE] Improve development documentation #1219

dai-chen opened this issue Jan 3, 2023 · 0 comments

Assignees

Labels

documentation enhancement

Collaborator

dai-chen commented Jan 3, 2023 •

edited

Loading

Is your feature request related to a problem?

Currently all dev docs are in a single folder https://github.com/opensearch-project/sql/tree/main/docs/dev. It's not well organized and missing high level introduction of the main changes over the time.

What solution would you like?

The improvement will be done in the following steps:

Reorganize development docs #1200
Add more dev and design docs for main new features
Add quick start doc with SQL/PPL standalone mode
Add JavaDoc generation task as API/SDK doc
TBD: Build Github pages website in same/separate repo

dai-chen added documentation enhancement labels

dai-chen self-assigned this

dai-chen mentioned this issue

Reorganize development docs #1200

Merged

6 tasks

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