[DOC] Ensure PPL docs have consistent look #926
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Lantao Jin <[email protected]>
Signed-off-by: Lantao Jin <[email protected]>
LantaoJin
requested review from
dai-chen,
mengweieric,
vmmusings,
penghuo,
seankao-az,
anirudha,
kaituo,
YANG-DB,
noCharger and
ykmr1224
as code owners
Signed-off-by: Lantao Jin <[email protected]>
brijos
reviewed
Nov 18, 2024
docs/ppl-lang/ppl-dedup-command.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # PPL dedup command | |||
| ## PPL dedup command | |||
There was a problem hiding this comment.
We are inconsistently using back ticks for commands. Let's use a back tick dedup
brijos
reviewed
Nov 18, 2024
docs/ppl-lang/ppl-grok-command.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| ## PPL Correlation Command | |||
| ## PPL Grok Command | |||
There was a problem hiding this comment.
should be lower case and include back ticks grok
brijos
reviewed
Nov 18, 2024
docs/ppl-lang/ppl-join-command.md
Outdated
| @@ -1,10 +1,115 @@ | |||
| ## PPL Join Command | |||
brijos
reviewed
Nov 18, 2024
docs/ppl-lang/ppl-lookup-command.md
Outdated
| @@ -1,20 +1,18 @@ | |||
| ## PPL Lookup Command | |||
brijos
reviewed
Nov 18, 2024
docs/ppl-lang/ppl-rare-command.md
Outdated
| @@ -1,11 +1,11 @@ | |||
| ## PPL rare Command | |||
brijos
reviewed
Nov 18, 2024
docs/ppl-lang/ppl-top-command.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| ## PPL top Command | |||
brijos
reviewed
Nov 18, 2024
| @@ -1,6 +1,6 @@ | |||
| ## PPL trendline Command | |||
brijos
suggested changes
Nov 18, 2024
Signed-off-by: Lantao Jin <[email protected]>
Done. Thanks @brijos |
|
@LantaoJin can u plz use this pr to also fix the hyper-link issue here ? |
YANG-DB
approved these changes
Nov 18, 2024
YANG-DB
added
documentation
Signed-off-by: Lantao Jin <[email protected]>
YANG-DB
approved these changes
Nov 19, 2024
kenrickyap
pushed a commit
to Bit-Quill/opensearch-spark
that referenced
this pull request
Dec 11, 2024
* refactor ppl docs to keep consistent look Signed-off-by: Lantao Jin <[email protected]> * remove auto generated file Signed-off-by: Lantao Jin <[email protected]> * minor updates Signed-off-by: Lantao Jin <[email protected]> * address comments Signed-off-by: Lantao Jin <[email protected]> * fix hyper-link issue Signed-off-by: Lantao Jin <[email protected]> --------- Signed-off-by: Lantao Jin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Main updates:
Renamed functions/ppl-lambda.md -> functions/ppl-collection.md
Move lambda functions to functions/ppl-json.md
Refactor ppl-join-command.md, ppl-lookup-command.md, ppl-subquery-command.md
Related Issues
Resolves #925
Check List
--signoffBy 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.