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

adding index module code examples #2554

Merged
merged 2 commits into from
May 17, 2024
Merged

Conversation

Copy link

github-actions bot commented May 7, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

Copy link
Member

@pquentin pquentin left a 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.

"index-modules/slowlog.asciidoc",
"index-modules/store.asciidoc",
"index-modules/index-sorting.asciidoc",
"index-modules/indexing-pressure.asciidoc"
Copy link
Member

@pquentin pquentin May 15, 2024

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

Copy link
Contributor Author

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.

Copy link
Member

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.

Copy link
Member

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.

Copy link
Member

@pquentin pquentin left a 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.

@pquentin pquentin merged commit 3a1cd62 into main May 17, 2024
18 checks passed
@pquentin pquentin deleted the annie/index_module_code_examples branch May 17, 2024 06:39
github-actions bot pushed a commit that referenced this pull request May 17, 2024
* adding index module code examples

* adding trailing comma

(cherry picked from commit 3a1cd62)
pquentin added a commit that referenced this pull request Jun 6, 2024
* adding index module code examples (#2554)

* adding index module code examples

* adding trailing comma

(cherry picked from commit 3a1cd62)

* Run examples generation again

---------

Co-authored-by: Annie Hansen <annie.gale@elastic.co>
Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants