opensearch-project / opensearch-plugins

For all things OpenSearch plugins. You want to install, or develop a plugin? You've come to the right place.
Apache License 2.0
51 stars 61 forks source link

Add details for gradle custom plugin. #144

Closed prudhvigodithi closed 2 years ago

prudhvigodithi commented 2 years ago

Signed-off-by: pgodithi pgodithi@amazon.com

Custom plugin's readme

Description

This PR will add a doc for gradle custom plugins and explains in details on how to use opensearch.pluginzip plugin

Issues Resolved

https://github.com/opensearch-project/opensearch-plugins/issues/143

Associated issues

https://github.com/opensearch-project/opensearch-build/issues/1916

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.

prudhvigodithi commented 2 years ago

Hey @dblock can you please review this PR? (To better Read) I will link this doc to the issue's created for each plugin repo as as part of the campaign. Example the issue will be something like this https://github.com/prudhvigodithi/opensearch-build/issues/18

prudhvigodithi commented 2 years ago

Thanks @gaiksaya, added all your suggestions in the latest commits.

prudhvigodithi commented 2 years ago

Hey @dblock, you suggest to move the data of GRADLE_CUSTOM_PLUGINS.md(added via this PR) to BUILDING.md? Also Coming to opensearch-plugin-template-java, this I see for creating any new OpenSearch plugins repo and but not for gradle plugins (under buildSrc/), did I miss anything from you previous comment ?

prudhvigodithi commented 2 years ago

Hey @dblock migrated the details to BUILDING.md. PR for opensearch-plugin-template-java Once this is merged I will add a new PR for opensearch-plugin-template-java to add details about opensearch.pluginzip

bbarani commented 2 years ago

I mostly have nitpicks, the doc is good!

@dblock Can we go ahead and merge this PR and work on the nitpicks later? I would like to see the teams start publishing the plugin zips from 2.0 GA version.

prudhvigodithi commented 2 years ago

Hey @dblock I have pushed some suggested NIT's, please review. Thanks