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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 24 commits into from
Jul 9, 2020
Merged

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

merged 24 commits into from
Jul 9, 2020

Commits on Jul 8, 2020

  1. HSEARCH-3598 Document the predicate DSL in details

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    d9ac0ce View commit details
    Browse the repository at this point in the history

  2. HSEARCH-3599 Document the sort DSL in details

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    2e5840a View commit details
    Browse the repository at this point in the history

  3. HSEARCH-3600 Document the projection DSL in details

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    9170a35 View commit details
    Browse the repository at this point in the history

  4. HSEARCH-3677 Upgrade to Hibernate asciidoc themes 1.0.4.Final 

    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.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    504fba9 View commit details
    Browse the repository at this point in the history

  5. HSEARCH-3668 Document the aggregation DSL in details

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    41f2b22 View commit details
    Browse the repository at this point in the history

  6. HSEARCH-3677 Remove the "advanced features" section from the document… 

    …ation

We'll just add sections where they belong (Elasticsearch backend, Lucene
backend, ...) instead of regrouping everything "advanced" in a single
section.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    e3b0c86 View commit details
    Browse the repository at this point in the history

  7. HSEARCH-3677 Remove misleading TODO from the Configuration section of… 

    … the documentation

There's nothing left "to do" there.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    3ecb546 View commit details
    Browse the repository at this point in the history

  8. HSEARCH-3677 Fill in the "further reading" section of the documentation 

    Leave out the Hibernate Search books, because unfortuately they are completely
obsolete.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    dc74876 View commit details
    Browse the repository at this point in the history

  9. HSEARCH-3677 Remove the "Index optimization" section from the documen… 

    …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.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    66248e7 View commit details
    Browse the repository at this point in the history

  10. HSEARCH-3677 Update a ticket reference

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    58290ea View commit details
    Browse the repository at this point in the history

  11. HSEARCH-3677 Remove the "Monitoring" section from the documentation 

    We're probably not going to restore monitoring in 6.0.0.Final.
Maybe in 6.1, but probably not based on JMX.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    27c1814 View commit details
    Browse the repository at this point in the history

  12. HSEARCH-3677 Restore preface from Hibernate Search 5

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    75d0a55 View commit details
    Browse the repository at this point in the history

  13. HSEARCH-3677 Use the same warning everywhere for incubating features

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    c49c3c5 View commit details
    Browse the repository at this point in the history

  14. HSEARCH-3710 Document declaration of dependencies in bridges

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    d054648 View commit details
    Browse the repository at this point in the history

  15. HSEARCH-3677 Fix incomplete documentation for dependency injection in… 

    …to bridges
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    736b419 View commit details
    Browse the repository at this point in the history

  16. HSEARCH-3709 Document routing key bridges

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    8495124 View commit details
    Browse the repository at this point in the history

  17. HSEARCH-3962 Document possible architectures

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    e029e1b View commit details
    Browse the repository at this point in the history

  18. HSEARCH-3677 Document that associations must be updated consistently 

    https://hibernate.zulipchat.com/#narrow/stream/132096-hibernate-user/topic/Hibernate.20Search.206.20-.20Auto.20reindexing.20of.20IndexedEmbedded
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    6b3a663 View commit details
    Browse the repository at this point in the history

  19. HSEARCH-3677 Break down the mapping documentation into multiple sourc… 

    …e files

Because it's getting really hard to find something in a 1500-line-long
file.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    0fb718c View commit details
    Browse the repository at this point in the history

  20. HSEARCH-3680 Update obsolete comments/documentation related to dynami… 

    …c-map entities
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    3d675d8 View commit details
    Browse the repository at this point in the history

  21. HSEARCH-3680 Use a separate helper for documentation tests

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    72b4ede View commit details
    Browse the repository at this point in the history

  22. HSEARCH-3680 Use a better default for the automatic indexing sync str… 

    …ategy in DocumentationSetupHelper

... instead of copy-pasting the same settings everyhwere.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    94e1c64 View commit details
    Browse the repository at this point in the history

  23. HSEARCH-3680 Use utils in DocumentationSetupHelper to generate test p… 

    …arameters

... instead of copy-pasting the same code everywhere.
    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    26659c2 View commit details
    Browse the repository at this point in the history

  24. HSEARCH-3680 Document the programmatic mapping

    @yrodiere
    yrodiere committed Jul 8, 2020
    Configuration menu
    Copy the full SHA
    067f115 View commit details
    Browse the repository at this point in the history