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.

Sign up for GitHub

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

Jump to bottom

[PROPOSAL] Better readme instructions #227

Open

jholla-atx opened this issue Oct 4, 2023 · 1 comment

Labels

discuss documentation

jholla-atx commented Oct 4, 2023

Readme for installing plugins is not clear on how to do it.

github-actions bot added the untriaged label

Member

dblock commented Oct 5, 2023

Does the public documentation help? https://opensearch.org/docs/latest/install-and-configure/plugins/. If so we should link it from README. Generally that's the guide for users.

For developers we can put things in README. Someone recently asked how to write a plugin on Slack and I pointed to https://code.dblock.org/2023/09/29/writing-opensearch-plugins-and-extensions.html. It shows how to do build a plugin with a RESTful API (and an extension in Java and Python). We should improve the README here taking some of that in.

Care to help add/edit what we have here @jholla-atx?

dblock added documentation discuss and removed untriaged labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment