Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Update documentation #528

Closed
dai-chen opened this issue Jun 19, 2020 · 9 comments
Closed

Update documentation #528

dai-chen opened this issue Jun 19, 2020 · 9 comments
Assignees

Comments

@dai-chen
Copy link
Member

dai-chen commented Jun 19, 2020

Update development guide with our new project structure (new Gradle submodule and ./gradlew command changes) and Git workflow we follow (the new develop branch): https://github.com/opendistro-for-elasticsearch/sql/blob/master/docs/developing.rst

@dai-chen dai-chen added the maintenance Improves code quality, but not the product label Jun 19, 2020
@dai-chen
Copy link
Member Author

JDK version in README is out-of-date. Should be JDK 14+.

@dai-chen dai-chen self-assigned this Jul 31, 2020
@dai-chen
Copy link
Member Author

dai-chen commented Aug 13, 2020

There was confusion reported in issue #607. So we need to clarify field type is nested: https://github.com/opendistro-for-elasticsearch/sql/blob/master/docs/user/beyond/partiql.rst#example-employees

@dai-chen dai-chen changed the title Update development guide Update documentation Aug 13, 2020
@dai-chen dai-chen added documentation and removed maintenance Improves code quality, but not the product labels Aug 13, 2020
@Hokwang
Copy link

Hokwang commented Oct 5, 2020

I am waiting this doc updates.

@Hokwang
Copy link

Hokwang commented Oct 27, 2020

@dai-chen any updates?

@dai-chen
Copy link
Member Author

@dai-chen any updates?

Hi @Hokwang , I just created local branch for this. Could you let me know which update are you waiting for?

@Hokwang
Copy link

Hokwang commented Oct 28, 2020

@dai-chen it is #607.

@dai-chen
Copy link
Member Author

@dai-chen it is #607.

I see. Will try to get it updated soon. Thanks!

@Hokwang
Copy link

Hokwang commented Nov 19, 2020

@dai-chen Thanks for your great doc work. but I think you need to update one more thing. https://opendistro.github.io/for-elasticsearch-docs/docs/sql/workbench/
actually I read this page at first time. I think repo is https://github.com/opendistro/for-elasticsearch-docs/.

@dai-chen
Copy link
Member Author

@Hokwang thanks for reminding! yeah, that's our doc repo for all ref manual. we will push all latest doc later.

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

No branches or pull requests

2 participants