Yoann Rodière (
https://hibernate.atlassian.net/secure/ViewProfile.jspa?accountId=557058%...
) *created* an issue
Hibernate Search (
https://hibernate.atlassian.net/browse/HSEARCH?atlOrigin=eyJpIjoiOTNmNDMz...
) / Improvement (
https://hibernate.atlassian.net/browse/HSEARCH-4898?atlOrigin=eyJpIjoiOTN...
) HSEARCH-4898 (
https://hibernate.atlassian.net/browse/HSEARCH-4898?atlOrigin=eyJpIjoiOTN...
) Give more context in the Hibernate Search guides (
https://hibernate.atlassian.net/browse/HSEARCH-4898?atlOrigin=eyJpIjoiOTN...
)
Issue Type: Improvement Assignee: Unassigned Components: documentation Created:
07/Jul/2023 08:34 AM Fix Versions: 7.0-backlog, 6.2.1.Final Priority: Major Reporter:
Yoann Rodière (
https://hibernate.atlassian.net/secure/ViewProfile.jspa?accountId=557058%...
)
Now that getting started guides are separate documentation, some of the wording is a bit
confusing because it lacks context.
For example, the getting started guide for the ORM integration has the title:
Getting started with the Hibernate ORM integration
But… integration of what? It should be:
Getting started with Hibernate Search in Hibernate ORM
I suspect there are more places that lack context like this. We need to look for those and
fix them.
For example the first sentence in the guide:
This guide will walk you through the initial steps required to index and
query your Hibernate ORM entities using Hibernate Search.
We should probably add a link to the reference documentation or the website on “Hibernate
ORM” and “Hibernate Search”, since these are the first time in the document they are
mentioned, and they weren’t introduced.
(
https://hibernate.atlassian.net/browse/HSEARCH-4898#add-comment?atlOrigin...
) Add Comment (
https://hibernate.atlassian.net/browse/HSEARCH-4898#add-comment?atlOrigin...
)
Get Jira notifications on your phone! Download the Jira Cloud app for Android (
https://play.google.com/store/apps/details?id=com.atlassian.android.jira....
) or iOS (
https://itunes.apple.com/app/apple-store/id1006972087?pt=696495&ct=Em...
) This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100230- sha1:acc9c6f )