Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]Revise and edit PPL in-product documentation #1233

Merged
merged 116 commits into from
Jan 17, 2024

Conversation

vagimeli
Copy link
Contributor

@vagimeli vagimeli commented Nov 8, 2023

Description

Revises PPL in-produce for clarity and edits grammatical, spelling, and other writing errors.

UX note: The manual opens to the where command section. Update to open to the Overview section. See the following image for reference.

Screenshot 2023-11-13 at 4 35 50 PM

Issues Resolved

opensearch-project/documentation-website#1152

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.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (80f112a) 44.06% compared to head (a5f621a) 56.32%.
Report is 131 commits behind head on main.

❗ Current head a5f621a differs from pull request most recent head 65ac8c5. Consider uploading reports for the commit 65ac8c5 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1233       +/-   ##
===========================================
+ Coverage   44.06%   56.32%   +12.26%     
===========================================
  Files         329      327        -2     
  Lines       19672    11944     -7728     
  Branches     4685     2741     -1944     
===========================================
- Hits         8669     6728     -1941     
+ Misses      10958     5171     -5787     
  Partials       45       45               
Flag Coverage Δ
dashboards-observability 56.32% <100.00%> (+12.26%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@Swiddis Swiddis added the documentation Improvements or additions to documentation label Dec 7, 2023
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

vagimeli commented Dec 8, 2023

@anirudha I've rewritten the PPL reference manual (in-product) documentation. The old version has several writing and tech inaccuracies. This revised version has gone through tech and editorial review is ready to be published. Who can I work with to get this published? Also, we need to change the page on which the manual opens. It currently opens to the where command section. It needs to open to the Overview section. Thanks for your help in moving this forward.

cc: @hdhalter

@vagimeli
Copy link
Contributor Author

vagimeli commented Jan 3, 2024

@anirudha @joshuali925 @hdhalter Is this PR ready to be merged? The content was rewritten, especially for clarity, grammar, and relevancy. It's gone through tech review, doc review, and editorial review. What are the next steps to update the UI changes and publish content to Dashboards?

The following UI updates are needed:

  1. Update link to PPL Documentation in Query Workbench. Link should be https://opensearch.org/docs/latest/search-plugins/sql/ppl/index/.
  2. Update PPL in-product homepage to open to Overview section instead of the where command section. See following image:
Screenshot 2024-01-03 at 2 12 52 PM

@vagimeli
Copy link
Contributor Author

@anirudha @joshuali925 @hdhalter Is this PR ready to be merged? The content was rewritten, especially for clarity, grammar, and relevancy. It's gone through tech review, doc review, and editorial review. What are the next steps to update the UI changes and publish content to Dashboards?

The following UI updates are needed:

  1. Update link to PPL Documentation in Query Workbench. Link should be https://opensearch.org/docs/latest/search-plugins/sql/ppl/index/.
  2. Update PPL in-product homepage to open to Overview section instead of the where command section. See following image:
Screenshot 2024-01-03 at 2 12 52 PM

Thanks for making the UI changes :)

@bbarani
Copy link
Member

bbarani commented Jan 17, 2024

@anirudha @joshuali925 Whats the next step here? Can we target this for 2.12.0 release? What are the next steps to update the UI changes and publish content to Dashboards?

@joshuali925 joshuali925 merged commit 31b0a94 into opensearch-project:main Jan 17, 2024
6 of 9 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 17, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit 31b0a94)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ps48 pushed a commit that referenced this pull request Jan 18, 2024
(cherry picked from commit 31b0a94)

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
joshuali925 added a commit to joshuali925/dashboards-observability that referenced this pull request Jan 18, 2024
Signed-off-by: Joshua Li <joshuali925@gmail.com>
joshuali925 added a commit that referenced this pull request Jan 18, 2024
Signed-off-by: Joshua Li <joshuali925@gmail.com>
paulstn pushed a commit to paulstn/dashboards-observability that referenced this pull request Jan 22, 2024
…#1233)

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
amsiglan pushed a commit to amsiglan/dashboards-observability that referenced this pull request Jun 7, 2024
…#1233) (opensearch-project#1368)

(cherry picked from commit 31b0a94)

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit 65f8eaa)
amsiglan pushed a commit to amsiglan/dashboards-observability that referenced this pull request Jun 7, 2024
Signed-off-by: Joshua Li <joshuali925@gmail.com>
(cherry picked from commit 57db4dc)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants