-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
adding index module code examples #2554
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! That's great. Sorry for the delay, I was on PTO.
utils/generate-examples.py
Outdated
"index-modules/slowlog.asciidoc", | ||
"index-modules/store.asciidoc", | ||
"index-modules/index-sorting.asciidoc", | ||
"index-modules/indexing-pressure.asciidoc" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a trailing comma here to fix the lint error here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hope you had the best time off! I have been careful to only add the examples I have investigated, but noticed a number for pre-existing files that look to be making some changes to their examples, I was going to see if I pushed a draft if we could review them and confirm that they should be added, but wanted to get a feel for it this is over stepping.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey Annie, thanks for the careful consideration here. This is not over stepping, but maybe unnecessary work as we update existing examples just before releases anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would be nice however would be to modify utils/generate-examples.py to exclude empty examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for iterating! LGTM.
* adding index module code examples * adding trailing comma (cherry picked from commit 3a1cd62)
Hi! I found additional docs that do not have the Python code examples.
Index Modules: