Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/docs-pr-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
pull_request:
branches:
- "dev"
- "cypher-25"
- "5.x"
- "4.[0-9]"
- "3.5"
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/docs-teardown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
pull_request_target:
branches:
- "dev"
- "cypher-25"
- "5.x"
- "4.[0-9]"
- "3.5"
Expand Down
11 changes: 6 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
Expand All @@ -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.
7 changes: 3 additions & 4 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -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'
4 changes: 2 additions & 2 deletions preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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[]
Expand Down
15 changes: 4 additions & 11 deletions publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/*'
Expand All @@ -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

Expand Down Expand Up @@ -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

Loading