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

New Indexes chapter #770

Merged
merged 34 commits into from
Jan 10, 2024
Merged

New Indexes chapter #770

merged 34 commits into from
Jan 10, 2024

Conversation

JPryce-Aklundh
Copy link
Contributor

No description provided.

@neo-technology-commit-status-publisher
Copy link
Collaborator

This PR includes documentation updates.

You can view the updated docs at https://neo4j-docs-cypher-770.surge.sh

stefano-ottolenghi
stefano-ottolenghi reviewed Nov 2, 2023
View reviewed changes
Copy link
Contributor

@stefano-ottolenghi stefano-ottolenghi left a comment

Choose a reason for hiding this comment

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

This greatly improves the structure and reader experience of the full-text indexes page, good stuff here!! 🤸

I like the new structure and how examples get progressively more complex, exposing more features as we read along.

modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/indexes-for-full-text-search.adoc Outdated Show resolved Hide resolved
@JPryce-Aklundh JPryce-Aklundh marked this pull request as ready for review January 9, 2024 13:55
stefano-ottolenghi
stefano-ottolenghi reviewed Jan 9, 2024
View reviewed changes
Copy link
Contributor

@stefano-ottolenghi stefano-ottolenghi left a comment

Choose a reason for hiding this comment

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

Mostly for page titles to better describe their content.

modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/index-hints.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/index.adoc
@@ -0,0 +1,22 @@
:description: Information about using indexes in Neo4j.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
:description: Information about using indexes in Neo4j.
:description: Information about using indexes in Neo4j.
:page-toclevels: 0

modules/ROOT/pages/indexes/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/overview.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/overview.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/overview.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/semantic-indexes/full-text-indexes.adoc Show resolved Hide resolved
modules/ROOT/pages/indexes/semantic-indexes/vector-indexes.adoc Show resolved Hide resolved
stefano-ottolenghi
stefano-ottolenghi reviewed Jan 10, 2024
View reviewed changes
Copy link
Contributor

@stefano-ottolenghi stefano-ottolenghi left a comment

Choose a reason for hiding this comment

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

  • examples h5 have a smaller font size than regular text
  • use tooltip to provide brief "practical" description of predicate
  • our own cypher styleguide privileges camelcase over snakecase, so it may be nice to reflect that in examples (i.e. nodeTextIndexNickname instead of node_text_index_nickname)
  • List indexes output table has label Default output for 80% of rows, more meaningful to drop that and give a Extended output label for the remaining 20%.

modules/ROOT/pages/indexes/index.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/managing-indexes.adoc Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc Outdated Show resolved Hide resolved
@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

stefano-ottolenghi
stefano-ottolenghi approved these changes Jan 10, 2024
View reviewed changes
Copy link
Contributor

@stefano-ottolenghi stefano-ottolenghi left a comment

Choose a reason for hiding this comment

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

An encouraging green tick 🤸

@JPryce-Aklundh JPryce-Aklundh merged commit b90c9cf into neo4j:dev Jan 10, 2024
5 checks passed
@JPryce-Aklundh JPryce-Aklundh deleted the indexes branch January 10, 2024 11:41
JPryce-Aklundh added a commit to JPryce-Aklundh/docs-cypher that referenced this pull request Jan 18, 2024
@JPryce-Aklundh
New Indexes chapter (neo4j#770)
28a26ee
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stefano-ottolenghi stefano-ottolenghi stefano-ottolenghi approved these changes

Assignees
No one assigned
Labels
5.16 Cypher Manual Restructure
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JPryce-Aklundh @neo-technology-commit-status-publisher @stefano-ottolenghi