From 1d3015d905487d44af74480dc83cf39eac57331f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Pryce-=C3=85klundh?= <112686610+JPryce-Aklundh@users.noreply.github.com> Date: Tue, 8 Oct 2024 15:21:58 +0200 Subject: [PATCH 1/3] cypher 2025 updates --- README.adoc | 11 ++++++----- antora.yml | 7 +++---- .../appendix/tutorials/advanced-query-tuning.adoc | 4 ++-- preview.yml | 4 ++-- publish.yml | 15 ++++----------- 5 files changed, 17 insertions(+), 24 deletions(-) diff --git a/README.adoc b/README.adoc index 71281a24f..2465dbcc9 100644 --- a/README.adoc +++ b/README.adoc @@ -48,7 +48,8 @@ If a change to an asciidoc file is detected, the site is automatically rebuilt. The docs-cypher repo (and all CoreDB docs repos) will contain the following branches: * `4.4` - Long term support -* `5.x` - this is the currently published version, and therefore is the branch that we publish all v5 docs from. +* `5.x` - Long term support. +* `cypher-25` - this is the currently published version, and therefore is the branch that we publish all v5 docs from. ** PRs merged into this branch will be published live immediately. * `dev` - this is always the next release - this branch will be published on the staging server, as a preview, but we will never publish from this branch publicly. ** Next means the “next version of documentation”, and may not mirror other Neo4j engineering repos. @@ -60,11 +61,11 @@ Within Github we’ll update the branch descriptions with what the current and n Here is the workflow for creating PRs in the repo, and our publication process: -* For any work on the **current** version, all work should be raised & merged against the `dev` branch, and cherry-picked back to `5.x` branch. +* For any work on the **current** version, all work should be raised & merged against the `dev` branch, and cherry-picked back to `cypher-25` branch. There are a few edge cases where we might want to work only on the current branch, for example adding a warning that is not needed in the next version - this is ok! * For content relating to the **next** release, raise PRs against the dev branch and use labels to mark the specific version it is targeting. * For work on **next+n** docs (i.e a version beyond **next**), we have 2 options: -** Open a draft PR against `dev`, with a label for the specific version it is targeting - this can be shared & reviewed in draft mode, but will not be mergeable until it is pointed at the next release. +** Open a draft PR against `dev`, with a label for the specific server version it is targeting (e.g. `2025.01` ) - this can be shared & reviewed in draft mode, but will not be mergeable until it is pointed at the next release. ** Create a feature branch from `dev`, to be merged into `dev` when appropriate. -* When a new version is ready to published, the `5.x` branch will get a git tag, named with the exact version (for example, **5.1.0**), signifying that this point-in-time marks the completion of the work for that minor release. -* Updates merged into the `dev` branch for the next release are cherry-picked into the `5.x` branch. +* When a new version is ready to published, the `cypher-25` branch will get a git tag, named with the exact version (for example, **2025.01.00**), signifying that this point-in-time marks the completion of the work for that minor release. +* Updates merged into the `dev` branch for the next release are cherry-picked into the `cypher-25` branch. diff --git a/antora.yml b/antora.yml index ef51b64c7..a09f496d9 100644 --- a/antora.yml +++ b/antora.yml @@ -1,11 +1,10 @@ name: cypher-manual title: Cypher Manual -version: '5' +version: '25' start_page: ROOT:introduction/index.adoc nav: - modules/ROOT/content-nav.adoc asciidoc: attributes: - neo4j-version: '5' - neo4j-version-minor: '5.25' - neo4j-version-exact: '5.25.0' + neo4j-version: '2025.01' + neo4j-version-minor: '2025.01.00' diff --git a/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc b/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc index 910b35f78..97ef34088 100644 --- a/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc +++ b/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc @@ -15,7 +15,7 @@ Let's explain how to use these features with a more advanced query tuning exampl [NOTE] ==== -If you are upgrading an existing store to {neo4j-version-exact}, it may be necessary to drop and re-create existing indexes. +If you are upgrading an existing store to {neo4j-version-minor}, it may be necessary to drop and re-create existing indexes. For information on native index support and upgrade considerations regarding indexes, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration[Operations Manual -> Performance -> Index configuration]. ==== @@ -939,7 +939,7 @@ Predicates that will not work: If there is an existence constraint on the property, no predicate is required to trigger the optimization. For example, `CREATE CONSTRAINT constraint_name FOR (p:Person) REQUIRE p.name IS NOT NULL` -As of Neo4j {neo4j-version-exact}, predicates with parameters, such as `WHERE n.prop > $param`, can trigger _index-backed ORDER BY_. +Predicates with parameters, such as `WHERE n.prop > $param`, can trigger _index-backed ORDER BY_. The only exception are queries with parameters of type `POINT`. ==== diff --git a/preview.yml b/preview.yml index fa119684c..21a469097 100644 --- a/preview.yml +++ b/preview.yml @@ -25,7 +25,7 @@ urls: antora: extensions: - require: "@neo4j-antora/antora-modify-sitemaps" - sitemap_version: '5' + sitemap_version: '25' sitemap_loc_version: 'current' move_sitemaps_to_components: true @@ -53,7 +53,7 @@ asciidoc: includePDF: false nonhtmloutput: "" experimental: '' - copyright: "2024 Neo4j, Inc." + copyright: "2025 Neo4j, Inc." common-license-page-uri: https://neo4j.com/docs/license/ docs-base-uri: https://neo4j.com/docs check-mark: icon:check[] diff --git a/publish.yml b/publish.yml index 49ad0451a..a44a20995 100644 --- a/publish.yml +++ b/publish.yml @@ -6,7 +6,7 @@ site: content: sources: - url: ./ - branches: ['3.5', '4.0', '4.1', '4.2', '4.3', '4.4', 'HEAD'] + branches: ['4.4', '5.x' 'HEAD'] edit_url: https://github.com/neo4j/docs-cypher/tree/{refname}/{path} exclude: - '!**/_includes/*' @@ -25,7 +25,7 @@ urls: antora: extensions: - require: "@neo4j-antora/antora-modify-sitemaps" - sitemap_version: '5' + sitemap_version: '25' sitemap_loc_version: 'current' move_sitemaps_to_components: true @@ -53,18 +53,11 @@ asciidoc: includePDF: false nonhtmloutput: "" experimental: '' - copyright: "2024 Neo4j, Inc." + copyright: "2025 Neo4j, Inc." common-license-page-uri: https://neo4j.com/docs/license/ docs-base-uri: https://neo4j.com/docs check-mark: icon:check[] cross-mark: icon:times[] neo4j-base-uri: '' neo4j-docs-base-uri: /docs - # NODES 2024 AD - page-ad-overline-link: https://neo4j.registration.goldcast.io/events/03805ea9-fe3a-4cac-8c15-aa622666531a?utm_source=neodocs&utm_medium=banner&utm_campaign=std - page-ad-image: https://neo4j.com/docs/assets/img/nodes-24.png - page-ad-title: Neo4j Online Developer Conference - page-ad-description: Join us on November 7 for live and unique tech talks over 24 hours across all timezones. - page-ad-link: https://neo4j.registration.goldcast.io/events/03805ea9-fe3a-4cac-8c15-aa622666531a?utm_source=neodocs&utm_medium=banner&utm_campaign=std - page-ad-underline-role: button - page-ad-underline: Register \ No newline at end of file + \ No newline at end of file From 6a5baca38da1584e85f4e7c18551eff374e1dda3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Pryce-=C3=85klundh?= <112686610+JPryce-Aklundh@users.noreply.github.com> Date: Tue, 8 Oct 2024 15:39:52 +0200 Subject: [PATCH 2/3] more --- .github/workflows/docs-pr-checks.yml | 1 + .github/workflows/docs-teardown.yml | 1 + README.adoc | 2 +- 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-pr-checks.yml b/.github/workflows/docs-pr-checks.yml index 07965cd90..0776f03d1 100644 --- a/.github/workflows/docs-pr-checks.yml +++ b/.github/workflows/docs-pr-checks.yml @@ -5,6 +5,7 @@ on: pull_request: branches: - "dev" + - "cypher-25" - "5.x" - "4.[0-9]" - "3.5" diff --git a/.github/workflows/docs-teardown.yml b/.github/workflows/docs-teardown.yml index e2dcc782c..3434992ef 100644 --- a/.github/workflows/docs-teardown.yml +++ b/.github/workflows/docs-teardown.yml @@ -5,6 +5,7 @@ on: pull_request_target: branches: - "dev" + - "cypher-25" - "5.x" - "4.[0-9]" - "3.5" diff --git a/README.adoc b/README.adoc index 2465dbcc9..a3dfe1c43 100644 --- a/README.adoc +++ b/README.adoc @@ -49,7 +49,7 @@ The docs-cypher repo (and all CoreDB docs repos) will contain the following bran * `4.4` - Long term support * `5.x` - Long term support. -* `cypher-25` - this is the currently published version, and therefore is the branch that we publish all v5 docs from. +* `cypher-25` - this is the currently published version, and therefore is the branch that we publish all Cypher 25 docs from. ** PRs merged into this branch will be published live immediately. * `dev` - this is always the next release - this branch will be published on the staging server, as a preview, but we will never publish from this branch publicly. ** Next means the “next version of documentation”, and may not mirror other Neo4j engineering repos. From 8d381094261f8e09e0629fed40496d1868a33a3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Pryce-=C3=85klundh?= <112686610+JPryce-Aklundh@users.noreply.github.com> Date: Tue, 8 Oct 2024 16:37:52 +0200 Subject: [PATCH 3/3] revert change on query tuning --- .../ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc b/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc index 97ef34088..910b35f78 100644 --- a/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc +++ b/modules/ROOT/pages/appendix/tutorials/advanced-query-tuning.adoc @@ -15,7 +15,7 @@ Let's explain how to use these features with a more advanced query tuning exampl [NOTE] ==== -If you are upgrading an existing store to {neo4j-version-minor}, it may be necessary to drop and re-create existing indexes. +If you are upgrading an existing store to {neo4j-version-exact}, it may be necessary to drop and re-create existing indexes. For information on native index support and upgrade considerations regarding indexes, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration[Operations Manual -> Performance -> Index configuration]. ==== @@ -939,7 +939,7 @@ Predicates that will not work: If there is an existence constraint on the property, no predicate is required to trigger the optimization. For example, `CREATE CONSTRAINT constraint_name FOR (p:Person) REQUIRE p.name IS NOT NULL` -Predicates with parameters, such as `WHERE n.prop > $param`, can trigger _index-backed ORDER BY_. +As of Neo4j {neo4j-version-exact}, predicates with parameters, such as `WHERE n.prop > $param`, can trigger _index-backed ORDER BY_. The only exception are queries with parameters of type `POINT`. ====