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

Remove broken link from DEVELOPER_GUIDE.md #2582

Merged
merged 4 commits into from
Mar 24, 2023

Conversation

nurSaadat
Copy link
Contributor

@nurSaadat nurSaadat commented Mar 23, 2023

Description

  • Category
    Documentation
  • Why these changes are required?
    These changes keep the documentation up-to-date according to the changes which were introduced in earlier contributions.
  • What is the old behavior before changes and new behavior after changes?
    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 #1623

Issues Resolved

Testing

Tested manually by reviewing the edited .md document in the forked repo.
image

Check List

  • New functionality includes testing
  • New functionality has been documented
  • 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: Saadat Nursultan <nursultan.saadat@gmail.com>
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
cwperks
cwperks previously approved these changes Mar 23, 2023
@cwperks
Copy link
Member

cwperks commented Mar 23, 2023

Thank you for the contribution @nurSaadat! The change looks good to me. It could be worth mentioning that the output of ./gradlew clean assemble will be in the build/distributions/ directory and that you can find the plugin-descriptor.properties file by unzipping the zip file that is created and finding it in the root level of the unzipped directory. The lines to look for are:

# 'opensearch.version': semantic version of opensearch the plugin is compatible with
# does not include -SNAPSHOT if compiled against a snapshot build
opensearch.version=3.0.0

Copy link
Contributor

@stephen-crawford stephen-crawford left a 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-commenter
Copy link

codecov-commenter commented Mar 23, 2023

Codecov Report

Merging #2582 (4844934) into main (575c2bc) will increase coverage by 0.03%.
The diff coverage is n/a.

📣 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.

Copy link
Member

@peternied peternied left a 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.

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
@nurSaadat nurSaadat dismissed stale reviews from stephen-crawford and cwperks via 0d7fedb March 24, 2023 09:08
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

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

Thanks, much better!

Copy link
Contributor

@stephen-crawford stephen-crawford left a 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!

@stephen-crawford stephen-crawford merged commit 30c967e into opensearch-project:main Mar 24, 2023
MaciejMierzwa pushed a commit to MaciejMierzwa/security that referenced this pull request Apr 20, 2023
* 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>
MaciejMierzwa pushed a commit to MaciejMierzwa/security that referenced this pull request Apr 27, 2023
* 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>
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.

Broken link in the DEVELOPER_GUIDE.md
5 participants