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

Reorganize documentation and add samples. #447

Merged
merged 1 commit into from
Jul 24, 2023

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 24, 2023

Description

  • Reduces user guide to a basic starter with links to all advanced topics.
  • Standardizes titles and TOCs.
  • Adds minimal information about plugins.
  • Links all leaf/orphaned guides/documents.
  • Adds a working hello world sample that can be run with the current version of code (using poetry).
  • Cleanup CHANGELOG

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.

@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Merging #447 (8631c72) into main (5866880) will not change coverage.
The diff coverage is n/a.

❗ Current head 8631c72 differs from pull request most recent head ad7f354. Consider uploading reports for the commit ad7f354 to get more accurate results

@@           Coverage Diff           @@
##             main     #447   +/-   ##
=======================================
  Coverage   71.49%   71.49%           
=======================================
  Files          81       81           
  Lines        7668     7668           
=======================================
  Hits         5482     5482           
  Misses       2186     2186           

Signed-off-by: dblock <dblock@amazon.com>
@VachaShah VachaShah merged commit 58217d9 into opensearch-project:main Jul 24, 2023
@dblock dblock deleted the add-samples branch July 24, 2023 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants