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

Adding documentation on codec versioning #337

Conversation

martin-gaievski
Copy link
Member

Signed-off-by: Martin Gaievski [email protected]

Description

Put description of new versioning for codecs from PR description #328 to dev guide.

Issues Resolved

No master issue yet, aiming 2.0 release

Check List

  • Commits are signed as 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.

@martin-gaievski martin-gaievski added Documentation Update existing documentations such as README, instruction docs, etc. v2.0.0 labels Mar 29, 2022
@martin-gaievski martin-gaievski requested a review from a team March 29, 2022 22:54
@martin-gaievski martin-gaievski self-assigned this Mar 29, 2022
@@ -265,6 +265,26 @@ Here, we are testing BWC Tests with BWC version of plugin as 1.0.0.0. Make sure

Before adding any new tests to Backward Compatibility Tests, we should be aware that the tests in BWC are not independent. While creating an index, a test cannot use the same index name if it is already used in other tests. Also, adding extra operations to the existing test may impact other existing tests like graphCount.

## Codec Versioning
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add this(with a hyperlink) to the index on the top of this file ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack

@codecov-commenter
Copy link

codecov-commenter commented Mar 29, 2022

Codecov Report

Merging #337 (db15e81) into main (02c30cb) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #337   +/-   ##
=========================================
  Coverage     83.99%   83.99%           
  Complexity      900      900           
=========================================
  Files           130      130           
  Lines          3854     3854           
  Branches        353      353           
=========================================
  Hits           3237     3237           
  Misses          457      457           
  Partials        160      160           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 02c30cb...db15e81. Read the comment docs.

@martin-gaievski martin-gaievski merged commit bebf9a6 into opensearch-project:main Mar 30, 2022
martin-gaievski added a commit to martin-gaievski/k-NN that referenced this pull request Mar 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update existing documentations such as README, instruction docs, etc. v2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants