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

Update README and Developer Guide #520

Merged
merged 3 commits into from
Feb 12, 2024

Conversation

dbwiddis
Copy link
Member

Description

  • Updates the README with more context and links to our incremental development issue.
  • Adds a section to the Developer Guide identifying how to create new Workflow Steps.

Issues Resolved

Resolves #438

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.

@github-actions github-actions bot added the backport 2.x backport PRs to 2.x branch label Feb 12, 2024
@dbwiddis dbwiddis added skip-changelog backport 2.x backport PRs to 2.x branch and removed backport 2.x backport PRs to 2.x branch labels Feb 12, 2024
Copy link

codecov bot commented Feb 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (861616a) 72.03% compared to head (ffe41e1) 72.03%.

❗ Current head ffe41e1 differs from pull request most recent head 71ee8d7. Consider uploading reports for the commit 71ee8d7 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #520   +/-   ##
=========================================
  Coverage     72.03%   72.03%           
  Complexity      624      624           
=========================================
  Files            78       78           
  Lines          3161     3161           
  Branches        239      239           
=========================================
  Hits           2277     2277           
  Misses          780      780           
  Partials        104      104           

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

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@amitgalitz amitgalitz self-requested a review February 12, 2024 21:15
Signed-off-by: Daniel Widdis <[email protected]>
@dbwiddis dbwiddis merged commit 13f672e into opensearch-project:main Feb 12, 2024
27 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 12, 2024
* Update README and Developer Guide

Signed-off-by: Daniel Widdis <[email protected]>

* Add instructions for updating WorkflowResources enum

Signed-off-by: Daniel Widdis <[email protected]>

* Mention non-ML use cases.

Signed-off-by: Daniel Widdis <[email protected]>

---------

Signed-off-by: Daniel Widdis <[email protected]>
(cherry picked from commit 13f672e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dbwiddis pushed a commit that referenced this pull request Feb 13, 2024
Update README and Developer Guide (#520)

* Update README and Developer Guide



* Add instructions for updating WorkflowResources enum



* Mention non-ML use cases.



---------


(cherry picked from commit 13f672e)

Signed-off-by: Daniel Widdis <[email protected]>
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>
@dbwiddis dbwiddis deleted the update-devguide branch April 15, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x backport PRs to 2.x branch skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for creating new Workflow Steps
3 participants