Add planning document for PPL revisions #751
Conversation
Signed-off-by: YANGDB <[email protected]>
add reference to the plan Signed-off-by: YANGDB <[email protected]>
YANG-DB
requested review from
dai-chen,
rupal-bq,
vmmusings,
penghuo,
seankao-az,
anirudha and
kaituo
as code owners
YANG-DB
added
Roadmap:Search
|
@LantaoJin please review and see if I haven't missed anything - |
| - `since`: the version it was introduced | ||
|
|
||
| --- | ||
| ## Version 0.4 |
There was a problem hiding this comment.
are we going to follow semver? is minor versions will ensure the backward compatibility? Can we patch new commands to existing versions?
There was a problem hiding this comment.
yes thanks, I'll add this to the doc
| - `since`: the version it was introduced | ||
|
|
||
| --- | ||
| ## Version 0.4 |
There was a problem hiding this comment.
Can we change the version order to have recent versions first?
|
|
||
|
|
||
| --- | ||
| ## Version 0.5 |
There was a problem hiding this comment.
If this is the current version, can you update to Version 0.5 (Current)
There was a problem hiding this comment.
AFAIK the latest is 0.4.1
There was a problem hiding this comment.
@anasalkouz I've updated 0.5.0 to be the current release (latest)
| - `dedup` command with `allowedDuplication > 1` feature needs spark version >= 3.4 | ||
|
|
||
| --- | ||
| ## Version 0.6 |
There was a problem hiding this comment.
Assuming 0.5 is the current version. Why we need to add future versions? I think the purpose of this document to list commands against current and older versions, but not to document the roadmap or future work. is my understanding correct?
There was a problem hiding this comment.
@anasalkouz we do need to provide a plan for our future work to map into a version
- we need be transparent with our plans
- we need to allow the community to be aware of our goals and maybe try to influence
- we need our own team to be inform of what our plans are in terms of release and content
There was a problem hiding this comment.
I've changed the doc to only reflect pre-release & released artifacts
There was a problem hiding this comment.
@anasalkouz I've removed future versions and only reflect former, existing and pre-release versions
| - | ||
|
|
||
| Each command / function would have the following properties: | ||
| - `status`: the maturity of the feature (experimental, stable, deprecated) |
There was a problem hiding this comment.
what is the definitional of experimental?
There was a problem hiding this comment.
experimental is a feature that is just released and has no existing existence or reviewed in previous versions
I've added description for the different types
| @@ -24,45 +24,45 @@ For additional examples see the next [documentation](PPL-Example-Commands.md). | |||
|
|
|||
| - [`explain command `](PPL-Example-Commands.md/#explain) | |||
|
|
|||
| - [`dedup command `](ppl-dedup-command.md) | |||
| - [`dedup command `](commands/ppl-dedup-command.md) | |||
There was a problem hiding this comment.
could we add version / since on each command doc?
YANG-DB
added
Meta
| ### Limitations | ||
| - `fields - list` shows incorrect results for spark version 3.3 - see [issue](https://github.com/opensearch-project/opensearch-spark/pull/732) | ||
| - `eval` with comma separated expression needs spark version >= 3.4 | ||
| - `dedup` command with `allowedDuplication > 1` feature needs spark version >= 3.4 |
There was a problem hiding this comment.
rename also needs spark version >=3.5.1
| | rare | experimental | 0.5 | | ||
| | top | experimental | 0.5 | | ||
| | join | experimental | 0.6 | | ||
| | lookup | experimental | 0.6 | |
There was a problem hiding this comment.
lookup needs spark version >=3.5.1
- spark - status - introduced in Signed-off-by: YANGDB <[email protected]>
- spark - status - introduced in Signed-off-by: YANGDB <[email protected]>
|
closing this since we need to align on release process before using a dedicated issue |
Description
Add planning document for PPL revisions
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.