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

Add documentation for delete by query plugin #11584

Merged
merged 1 commit into from
Jun 23, 2015

Conversation

tlrx
Copy link
Member

@tlrx tlrx commented Jun 10, 2015

Add documentation for delete by query plugin (see #11516). This page is placed in a /plugins directory until we figure where to place all plugins documentation.

@tlrx tlrx added >docs General docs changes v2.0.0-beta1 review labels Jun 10, 2015
@dadoonet
Copy link
Member

@tlrx I made a proposal here elastic/elasticsearch-analysis-kuromoji#62 about plugin (module) documentation.
I think it should goes into src/main/asciidoc to meet maven convention for asciidoc docs.

So I'd make that consistent. In maven world, source files (code, documentation, resources...) should always be in src dir.

Would love to get @clintongormley thoughts about this so I can move my PR from the plugin repo to elasticsearch repo.

Since documents can be updated or deleted by external operations during the
scan-scroll-bulk process, the plugin keeps track of different counters:

[[delete-by-query-found]]
Copy link
Member

Choose a reason for hiding this comment

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

I would prefix with plugins- to be consistent with the very first tag.
Same for others.

@tlrx
Copy link
Member Author

tlrx commented Jun 16, 2015

@clintongormley I just updated with your modification, thanks for your review.

@dadoonet I think I created too many sub sections :) Thanks for your review by the way.

@clintongormley
Copy link
Contributor

LGTM - we'll need to change the << >> links when we move it into the plugin docs, but we can do that then.

@clintongormley clintongormley self-assigned this Jun 19, 2015
This page is placed in a /plugins directory until we figure where to place all plugins documentation.
@tlrx tlrx force-pushed the delete-by-query-doc branch from 17e6825 to 26e7827 Compare June 23, 2015 11:26
@tlrx tlrx merged commit 26e7827 into elastic:master Jun 23, 2015
@kevinkluge kevinkluge removed the review label Jun 23, 2015
@tlrx tlrx deleted the delete-by-query-doc branch June 23, 2015 11:27
@lcawl lcawl added :Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. and removed :Plugin Delete By Query labels Feb 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes v2.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants