HSEARCH-3598 + HSEARCH-3599 + HSEARCH-3600 + HSEARCH-3668 + HSEARCH-3677 + HSEARCH-3680 + HSEARCH-3709 + HSEARCH-3710 + HSEARCH-3962 Complete all missing sections of the documentation #2321
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
yrodiere
commented
Jul 8, 2020
yrodiere
commented
- HSEARCH-3598: Document the predicate DSL in details
- HSEARCH-3599: Document the sort DSL in details
- HSEARCH-3600: Document the projection DSL in details
- HSEARCH-3668: Document the aggregation DSL in details
- HSEARCH-3677: Complete all missing sections of the documentation
- HSEARCH-3680: Document the programmatic mapping
- HSEARCH-3709: Document routing key bridges
- HSEARCH-3710: Document declaration of dependencies in bridges
- HSEARCH-3962: Document possible architectures
So that we correctly display 4 levels of sections in the TOC. Otherwise some sections about predicates/sorts/etc. are too long and it's hard to navigate.
…ation We'll just add sections where they belong (Elasticsearch backend, Lucene backend, ...) instead of regrouping everything "advanced" in a single section.
… the documentation There's nothing left "to do" there.
Leave out the Hibernate Search books, because unfortuately they are completely obsolete.
…tation Everything related to merge/forceMerge is already document in the Lucene backend. And no, this section was not about optimization in general, but specifically about segment merging.
We're probably not going to restore monitoring in 6.0.0.Final. Maybe in 6.1, but probably not based on JMX.
…e files Because it's getting really hard to find something in a 1500-line-long file.
…ategy in DocumentationSetupHelper ... instead of copy-pasting the same settings everyhwere.
…arameters ... instead of copy-pasting the same code everywhere.
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.