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

Migrate readme from Elasticsearch plugin #19

Merged
merged 5 commits into from
Apr 12, 2021
Merged

Migrate readme from Elasticsearch plugin #19

merged 5 commits into from
Apr 12, 2021

Conversation

mjseaman
Copy link
Contributor

Add Elasticsearch docs with minor modifications for plugin name, feature list, PPL.

Add Elasticsearch docs with minor modifications for plugin name, feature list, PPL
@mjseaman
Copy link
Contributor Author

Image links haven't been updated yet.

Copy link
Contributor

@alexanderzobnin alexanderzobnin left a comment

Choose a reason for hiding this comment

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

Looks good. One detail: we have 2 readme files right now, one in the repo root and the other one in the src/ folder. Grafana use readme from src/ if it exists, so if we update the root readme, please, delete src/README.md, otherwise information that user will see in Grafana won't be updated.

README.md Outdated Show resolved Hide resolved
@mjseaman
Copy link
Contributor Author

This Elasticsearch templated dashboard is linked from the docs. @alexanderzobnin would we expect this to work the same way for ODFE, or should we consider creating a new templated dashboard example for ODFE? Another option would be simply to remove this line from the docs for now, since it is just a nice-to-have.

@mjseaman mjseaman requested a review from anirudha April 11, 2021 15:58
@mjseaman
Copy link
Contributor Author

Okay, I think this is ready for review. @anirudha I'd appreciate your feedback on the accuracy here, especially in the auth sections. @alexanderzobnin are all of these screenshots still accurate?

This should basically be just the same as the Elastic plugin, with the names changed, links updated, and a little snippet for PPL.

@mjseaman mjseaman marked this pull request as ready for review April 11, 2021 15:59
@mjseaman mjseaman merged commit cadf68e into master Apr 12, 2021
@mjseaman mjseaman deleted the readme branch April 12, 2021 12:59
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.

None yet

2 participants