opensearch-project / opensearch-project/sql
[FEATURE] Improve development documentation
Open
@dai-chen is already working on this.
Since Jan 3, 2023.
documentation
enhancement
- Dominant language
- Java
- Stars
- 176
- Forks
- 229
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 43
Description
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:
- https://github.com/opensearch-project/sql/pull/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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.