[hibernate-commits] [hibernate/hibernate-search] d58f26: HSEARCH-3601 Simplify an example in the documentation

Yoann Rodière noreply at github.com
Mon Jun 17 02:03:42 EDT 2019 

  Branch: refs/heads/master
  Home:   https://github.com/hibernate/hibernate-search
  Commit: d58f26d2174ccbe66bddb642c1f9105147ad2726
      https://github.com/hibernate/hibernate-search/commit/d58f26d2174ccbe66bddb642c1f9105147ad2726
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/entityindexmapping/HibernateOrmIndexedIT.java

  Log Message:
  -----------
  HSEARCH-3601 Simplify an example in the documentation


  Commit: 0e0a8d767a3c389cf19721d5d9b9566db5a1dd04
      https://github.com/hibernate/hibernate-search/commit/0e0a8d767a3c389cf19721d5d9b9566db5a1dd04
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/mapper-orm-indexing-automatic.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Fix a typo in the documentation


  Commit: 9ff1cc7e1764a3dd19781462a4134cf0da359f74
      https://github.com/hibernate/hibernate-search/commit/9ff1cc7e1764a3dd19781462a4134cf0da359f74
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/concepts.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Add previously missing todo placeholders to the "concepts" section of documentation


  Commit: e371f091992af316b9fad829b8997d6fef31071f
      https://github.com/hibernate/hibernate-search/commit/e371f091992af316b9fad829b8997d6fef31071f
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/backend-elasticsearch.asciidoc
    M documentation/src/main/asciidoc/getting-started.asciidoc
    M documentation/src/main/asciidoc/mapper-orm-mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Fix a few broken internal links in the documentation


  Commit: b6b191436ad8d00c269ed07758dbe448ac28ea2e
      https://github.com/hibernate/hibernate-search/commit/b6b191436ad8d00c269ed07758dbe448ac28ea2e
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/getting-started.asciidoc
    M documentation/src/test/java/org/hibernate/search/documentation/gettingstarted/withhsearch/withanalysis/Author.java
    M documentation/src/test/java/org/hibernate/search/documentation/gettingstarted/withhsearch/withanalysis/Book.java
    M documentation/src/test/java/org/hibernate/search/documentation/gettingstarted/withhsearch/withanalysis/MyElasticsearchAnalysisConfigurer.java
    M documentation/src/test/java/org/hibernate/search/documentation/gettingstarted/withhsearch/withanalysis/MyLuceneAnalysisConfigurer.java
    M documentation/src/test/resources/META-INF/persistence.xml

  Log Message:
  -----------
  HSEARCH-3601 Use better names for analyzers in the getting started guide


  Commit: e6ae0fc43e98c213c1503f95e6e8f887c8b7cf43
      https://github.com/hibernate/hibernate-search/commit/e6ae0fc43e98c213c1503f95e6e8f887c8b7cf43
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/directfieldmapping/Book.java
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/entityindexmapping/Author.java
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/entityindexmapping/Book.java
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/entityindexmapping/User.java
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/indexing/Author.java
    M documentation/src/test/java/org/hibernate/search/documentation/mapper/orm/indexing/Book.java
    M documentation/src/test/java/org/hibernate/search/documentation/searchdsl/DslConverterIT.java
    M documentation/src/test/java/org/hibernate/search/documentation/testsupport/ElasticsearchSimpleMappingAnalysisConfigurer.java
    M documentation/src/test/java/org/hibernate/search/documentation/testsupport/LuceneSimpleMappingAnalysisConfigurer.java

  Log Message:
  -----------
  HSEARCH-3601 Use better names for analyzers throughout the documentation examples


  Commit: 615b9cba119887ca7f074dae1427e11cc9099580
      https://github.com/hibernate/hibernate-search/commit/615b9cba119887ca7f074dae1427e11cc9099580
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/backend-elasticsearch.asciidoc
    M documentation/src/main/asciidoc/mapper-orm-indexing-automatic.asciidoc
    M documentation/src/main/asciidoc/search-dsl.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Add missing anchors and sections to to the documentation


  Commit: 595918bef25b3a6962bb57e41f4f87615103935f
      https://github.com/hibernate/hibernate-search/commit/595918bef25b3a6962bb57e41f4f87615103935f
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/getting-started.asciidoc
    M documentation/src/main/asciidoc/mapper-orm-mapping.asciidoc
    M documentation/src/main/asciidoc/mapper-orm-query.asciidoc
    M documentation/src/main/asciidoc/search-dsl.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Move introductions to the sort and projection DSL to the relevant sections of the documentation

We'll have to be much less verbose if we want to briefly introduce those
in the documentation of the query DSL: there are many other interesting
options to mention there.
Maybe an example with callouts and links will be enough?


  Commit: fd013814d9a72e0815a8d5e755e0a0636cb919a7
      https://github.com/hibernate/hibernate-search/commit/fd013814d9a72e0815a8d5e755e0a0636cb919a7
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/getting-started.asciidoc
    R documentation/src/main/asciidoc/mapper-orm-query.asciidoc
    M documentation/src/main/asciidoc/mapper-orm.asciidoc
    M documentation/src/main/asciidoc/search-dsl.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Create a dedicated section for the query DSL in the documentation

We can't just put it in the ORM integration, it's broader than that.


  Commit: 58301f21befaa836442f46e954d7f7cc1f7d8cf8
      https://github.com/hibernate/hibernate-search/commit/58301f21befaa836442f46e954d7f7cc1f7d8cf8
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/search-dsl.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Regroup all field type and compatibility sections under a single parent section


  Commit: 270bda8a539567b706129443871877e9834a9811
      https://github.com/hibernate/hibernate-search/commit/270bda8a539567b706129443871877e9834a9811
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/configuration.asciidoc
    M documentation/src/main/asciidoc/getting-started.asciidoc
    M documentation/src/main/asciidoc/index.asciidoc
    R documentation/src/main/asciidoc/mapper-orm-configuration.asciidoc
    M documentation/src/main/asciidoc/mapper-orm-indexing-automatic.asciidoc
    A documentation/src/main/asciidoc/mapper-orm-indexing.asciidoc
    M documentation/src/main/asciidoc/mapper-orm-mapping.asciidoc
    R documentation/src/main/asciidoc/mapper-orm.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Move a few sections of the documentation to make the table of contents clearer


  Commit: ff9b749233d585ad97defcf59a46cd48ed19e2ec
      https://github.com/hibernate/hibernate-search/commit/ff9b749233d585ad97defcf59a46cd48ed19e2ec
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M documentation/src/main/asciidoc/index.asciidoc

  Log Message:
  -----------
  HSEARCH-3601 Display 3 levels of headings in the table of contents

This will be necessary to display all predicates/sorts/projections in
the TOC, in particular.


  Commit: ed9e9a31da8942bc83d73a51840cd33ed6b16e0c
      https://github.com/hibernate/hibernate-search/commit/ed9e9a31da8942bc83d73a51840cd33ed6b16e0c
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M pom.xml

  Log Message:
  -----------
  HSEARCH-3601 Upgrade to asciidoctor-maven-plugin 1.5.8

This is necessary to take advantage of the new "abort the build on error" feature.


  Commit: 9a79a1b512f19bcd87ed3bbe17b9479a487a4fb7
      https://github.com/hibernate/hibernate-search/commit/9a79a1b512f19bcd87ed3bbe17b9479a487a4fb7
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2019-06-17 (Mon, 17 Jun 2019)

  Changed paths:
    M pom.xml

  Log Message:
  -----------
  HSEARCH-3601 Abort the Maven build on asciidoctor processing warnings/errors

E.g. if there are invalid internal links.


Compare: https://github.com/hibernate/hibernate-search/compare/c4f40b590c26...9a79a1b512f1

More information about the hibernate-commits mailing list