Skip to content

Reorganize development documentation#1092

Closed
dai-chen wants to merge 1 commit intoopensearch-project:2.xfrom
dai-chen:refactor-dev-docs
Closed

Reorganize development documentation#1092
dai-chen wants to merge 1 commit intoopensearch-project:2.xfrom
dai-chen:refactor-dev-docs

Conversation

@dai-chen
Copy link
Copy Markdown
Collaborator

@dai-chen dai-chen commented Nov 21, 2022

Signed-off-by: Chen Dai daichen@amazon.com

Description

TODO

Issues Resolved

N/A

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dai-chen
Add index for dev doc and reorganize
a97dbd3 
Signed-off-by: Chen Dai <daichen@amazon.com>
@dai-chen dai-chen added the documentation Improvements or additions to documentation label Nov 21, 2022
@dai-chen dai-chen self-assigned this Nov 21, 2022
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 21, 2022 •
edited
Loading

Codecov Report

Merging #1092 (a97dbd3) into 2.x (81c9285) will decrease coverage by 2.52%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##                2.x    #1092      +/-   ##
============================================
- Coverage     98.27%   95.75%   -2.53%     
- Complexity     3434     3450      +16     
============================================
  Files           343      355      +12     
  Lines          8540     9238     +698     
  Branches        544      666     +122     
============================================
+ Hits           8393     8846     +453     
- Misses          142      334     +192     
- Partials          5       58      +53
Flag Coverage Δ
query-workbench 62.76% <ø> (?)
sql-engine 98.28% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...ain/java/org/opensearch/sql/analysis/Analyzer.java 100.00% <0.00%> (ø)
...java/org/opensearch/sql/ppl/parser/AstBuilder.java 100.00% <0.00%> (ø)
...expression/function/BuiltinFunctionRepository.java 100.00% <0.00%> (ø)
...l/prometheus/storage/PrometheusStorageFactory.java 100.00% <0.00%> (ø)
...l/planner/physical/catalog/CatalogTableSchema.java
...sql/planner/physical/catalog/CatalogTableScan.java
.../analysis/CatalogSchemaIdentifierNameResolver.java
...rch/sql/planner/physical/catalog/CatalogTable.java
...alysis/DataSourceSchemaIdentifierNameResolver.java 100.00% <0.00%> (ø)
...anner/physical/datasource/DataSourceTableScan.java 100.00% <0.00%> (ø)
... and 14 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@dai-chen dai-chen mentioned this pull request Nov 28, 2022
Merged
6 tasks
MaxKsyunz
MaxKsyunz reviewed Dec 10, 2022
View reviewed changes
Copy link
Copy Markdown
Collaborator

@MaxKsyunz MaxKsyunz left a comment

Choose a reason for hiding this comment

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

@dai-chen where did the content in expression-pushdown.md originate?
It looks like it was written before V2 engine was added.

@dai-chen
Copy link
Copy Markdown
Collaborator Author

dai-chen commented Dec 12, 2022

@dai-chen where did the content in expression-pushdown.md originate? It looks like it was written before V2 engine was added.

Hi @MaxKsyunz It is part of the V2 engine from internal design documentation. I'm trying to make this kind of doc public in this PR as well.

@MaxKsyunz
Copy link
Copy Markdown
Collaborator

MaxKsyunz commented Dec 13, 2022

@dai-chen where did the content in expression-pushdown.md originate? It looks like it was written before V2 engine was added.

Hi @MaxKsyunz It is part of the V2 engine from internal design documentation. I'm trying to make this kind of doc public in this PR as well.

Much appreciated @dai-chen. Thank you!

@dai-chen
Copy link
Copy Markdown
Collaborator Author

dai-chen commented Dec 20, 2022

Default branch was changed. Will raise new PR after rebase.

@dai-chen dai-chen closed this Dec 20, 2022
@dai-chen dai-chen mentioned this pull request Dec 20, 2022
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ps48 ps48 Awaiting requested review from ps48 ps48 will be requested when the pull request is marked ready for review ps48 is a code owner

@joshuali925 joshuali925 Awaiting requested review from joshuali925 joshuali925 will be requested when the pull request is marked ready for review joshuali925 is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric will be requested when the pull request is marked ready for review mengweieric is a code owner

@Swiddis Swiddis Awaiting requested review from Swiddis Swiddis will be requested when the pull request is marked ready for review Swiddis is a code owner

@penghuo penghuo Awaiting requested review from penghuo penghuo will be requested when the pull request is marked ready for review penghuo is a code owner

@anirudha anirudha Awaiting requested review from anirudha anirudha will be requested when the pull request is marked ready for review anirudha is a code owner

@acarbonetto acarbonetto Awaiting requested review from acarbonetto acarbonetto will be requested when the pull request is marked ready for review acarbonetto is a code owner

@ykmr1224 ykmr1224 Awaiting requested review from ykmr1224 ykmr1224 will be requested when the pull request is marked ready for review ykmr1224 is a code owner

1 more reviewer

@MaxKsyunz MaxKsyunz MaxKsyunz left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@dai-chen dai-chen

Labels

documentation Improvements or additions to documentation

Projects

Test roadmap format
Status: Planned work items

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dai-chen @codecov-commenter @MaxKsyunz