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

Enhancement to custom plugin example documentation #41494

Closed
joshjanoski opened this issue Apr 24, 2019 · 3 comments
Closed

Enhancement to custom plugin example documentation #41494

joshjanoski opened this issue Apr 24, 2019 · 3 comments
Labels
:Core/Infra/Plugins Plugin API and infrastructure >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team

Comments

@joshjanoski
Copy link

joshjanoski commented Apr 24, 2019

This is a documentation enhancement request for the following page:

https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-authors.html

When trying to get started with one of the custom plugin examples referenced on that page here:

https://github.com/elastic/elasticsearch/tree/master/plugins/examples

I had trouble getting the examples to compile properly based on the information given. I later found out that gradle is the recommended way to compile the plugin examples and that Maven can also be used per this blog post: https://www.elastic.co/blog/how-to-develop-your-own-security-extensions-and-custom-realms-for-elasticsearch.

I would like to see the examples page updated with some basic instructions for using gradle and/or maven to compile the examples so that getting started with the plugin examples is easier. The information for doing this seems to be out there, but it isn't on this page and requires some hunting to find all of it.

Thank you for considering this enhancement!

@joshjanoski joshjanoski added the >docs General docs changes label Apr 24, 2019
@joshjanoski joshjanoski changed the title Enhancement to custom plugin Enhancement to custom plugin example documentation Apr 24, 2019
@colings86 colings86 added the :Core/Infra/Plugins Plugin API and infrastructure label Apr 25, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@debadair
Copy link
Contributor

[docs issue triage]

@rjernst rjernst added Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team labels May 4, 2020
@rjernst rjernst added the needs:triage Requires assignment of a team area label label Dec 3, 2020
@williamrandolph
Copy link
Contributor

Thank you for reporting this. If you don't mind, I will copy your comment to #15280 and close this ticket, since both tickets involve improving the same sparse documentation page.

@williamrandolph williamrandolph removed the needs:triage Requires assignment of a team area label label Jan 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/Plugins Plugin API and infrastructure >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team
Projects
None yet
Development

No branches or pull requests

6 participants