-
Notifications
You must be signed in to change notification settings - Fork 290
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
Remove broken link from DEVELOPER_GUIDE.md #2582
Remove broken link from DEVELOPER_GUIDE.md #2582
Conversation
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
Thank you for the contribution @nurSaadat! The change looks good to me. It could be worth mentioning that the output of
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great find! Thank you for your contribution :)
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## main #2582 +/- ##
============================================
+ Coverage 61.22% 61.26% +0.03%
- Complexity 3327 3331 +4
============================================
Files 260 260
Lines 18509 18509
Branches 3269 3269
============================================
+ Hits 11332 11339 +7
+ Misses 5579 5575 -4
+ Partials 1598 1595 -3 see 3 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing the broken link and updating the version numbers, but I think this section needs more detail on how to determine the compatible version of OpenSearch.
0d7fedb
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
3e208b2
to
4844934
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, much better!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for all your help with this!
* Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> --------- Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> Signed-off-by: Maciej Mierzwa <dev.maciej.mierzwa@gmail.com>
* Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> * Update DEVELOPER_GUIDE.md Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> --------- Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com> Signed-off-by: Maciej Mierzwa <dev.maciej.mierzwa@gmail.com>
Description
Documentation
These changes keep the documentation up-to-date according to the changes which were introduced in earlier contributions.
Before the changes, when clicking on the "here" link in the "Native platforms" section of DEVELOPER_GUIDE.md the user was redirected to a page with 404 error and a message
The 'opensearch-project/security' repository doesn't contain the 'plugin-descriptor.properties' path in 'main'.
After the changes, the "Worth noting" paragraph was put after building code snippet, so that the user will be able to access the
plugin-descriptor.properties
file, which is created programmatically after #1623Issues Resolved
Testing
Tested manually by reviewing the edited .md document in the forked repo.
Check List
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.