Merge branch 'dev' into cluster-procedure-and-routing-codes

Author: nick-giles-neo

README.adoc

@@ -33,11 +33,25 @@ You will still need to refresh the page to view the changes.
 [[contributing]]
 == Contributing
 
-To make changes to this repository, please create a fork of this repo and a new branch to stage your changes.
-Your branch should be prefixed with the version number, for example, `dev-new-examples`.
-
-When you are finished with your changes push the branch to your fork and create a Pull Request.
-Please add at least one approver.
+. To make changes to this repository, create a fork of this repo and a new branch to stage your changes.
+Your branch should be prefixed with `dev-` or the version if it is a specific version you are working on.
+. If you want to add a new GQLSTATUS code or update an existing one, you must start with the `neo4j` repo.
+The `neo4j` repo is the source of truth for all GQLSTATUS codes.
+. Add a page for each new GQLSTATUS code in the _docs-status-codes/modules/ROOT/pages/errors/gql-errors_ folder or update an existing one.
+The file name should be the same as the GQLSTATUS code, e.g., `08N02.adoc` for the `08N02` code.
+Use the same format as the other files in this folder.
+. Update the _content-nav.adoc_ file to reflect the added codes.
+Codes are ordered alphabetically.
+. If the standard description of a new GQLSTATUS code contains a new parameter, add this parameter to the _docs-status-codes/modules/ROOT/partials/glossary.adoc_ file as well.
+. GQLSTATUS codes are also listed on the index page.
+PLEASE DON’T EDIT IT.
+The _docs-status-codes/modules/ROOT/pages/errors/gql-errors/index.adoc_ file is created from a template and the codes and their status descriptions are automatically populated.
+If you want to update the index page with adding a new section or section description, please contact the Docs team.
+The Docs team is also responsible for keeping it consistent with the individual error files.
+. If possible, add an example of the new error and any extra information our users may benefit from on the error page.
+See the following pages for inspiration:
+https://neo4j.com/docs/status-codes/current/errors/gql-errors/08N02/, https://neo4j.com/docs/status-codes/current/errors/gql-errors/08N07/, and https://neo4j.com/docs/status-codes/current/errors/gql-errors/51N27/.
+. Let your team and Docs team review the PR.
 
 [[guidelines]]
 == Guidelines for writing errors and notifications

modules/ROOT/pages/errors/all-errors.adoc

@@ -6,6 +6,13 @@
 
 This page lists the current Neo4j error codes, which which are returned along side xref:errors/gql-errors/index.adoc[GQLSTATUS error codes], grouped by type.
 
+[NOTE]
+====
+Starting from 2025.04, using the error messages programmatically is deprecated.
+Because error messages might change in a future release, please parse or use GQLSTATUS error codes in your application code.
+For details, see xref:errors/gql-errors/index.adoc[GQLSTATUS error codes].
+====
+
 == Client errors
 
 This is a complete list of all client errors Neo4j may return, and what they mean.

modules/ROOT/pages/errors/gql-errors/42I14.adoc

@@ -1,7 +1,7 @@
 = 42I14
 
 == Status description
-error: syntax error or access rule violation - invalid number of relationship types. Exactly one relationship type must be specified for `{ <<var>> }`.
+error: syntax error or access rule violation - invalid number of relationship types. Exactly one relationship type must be specified for `{ <<variable>> }`.
 
 ifndef::backend-pdf[]
 [discrete.glossary]

modules/ROOT/pages/errors/gql-errors/index.adoc

@@ -840,7 +840,7 @@ Status description:: error: syntax error or access rule violation - invalid numb
 
 === xref:errors/gql-errors/42I14.adoc[42I14]
 
-Status description:: error: syntax error or access rule violation - invalid number of relationship types. Exactly one relationship type must be specified for `{ <<var>> }`.
+Status description:: error: syntax error or access rule violation - invalid number of relationship types. Exactly one relationship type must be specified for `{ <<variable>> }`.
 
 === xref:errors/gql-errors/42I15.adoc[42I15]
 

modules/ROOT/pages/notifications/all-notifications.adoc

@@ -1972,7 +1972,7 @@ Returned GQLSTATUS code::
 Returned status description::
 warn: feature deprecated with replacement.
 id is deprecated.
-It is replaced by elementId or an application-generated id.
+It is replaced by elementId or consider using an application-generated id.
 
 Suggestions for improvement::
 Use the function `elementId()` instead.

modules/ROOT/partials/glossary.adoc

@@ -3,6 +3,7 @@
 [[action]]$action:: Freeform description of an action.
 //$action will be replaced by cmd and msg depending on the usage.
 [[alias]]$alias:: An alias name, `mydb-alias`.
+[[aliasList]]$aliasList:: A list of alias names, for example, `mydb-alias1, mydb-alias2`.
 [[allocType]]$allocType:: Allocation type (`primary` or `secondary`).
 [[arg]]$arg:: Procedure or function argument, for example, `database`, `pause`, `dryrun`, etc.
 [[argType]]$argType:: Argument type, either input or output.
@@ -41,6 +42,7 @@
 //52N22 and 52N36 to change $field to $arg. Check 22N98 with Antonio.
 [[fun]]$fun:: Function name, for example, `collect()`.
 [[funClass]]$funClass:: User-defined function implementation class name, for example, `MyFunctionClass`.
+[[funType]]$funType:: Function type, e.g. non-deterministic or aggregate.
 [[graph]]$graph:: The name of a graph, for example, `myGraph`.
 [[graphTypeDependence]]$graphTypeDependence:: Graph type dependencency for constraint, one of `UNDESIGNATED`, `INDEPENDENT`, or `DEPENDENT`.
 [[hint]]$hint:: Freeform description of a hint, for example, `USING INDEX n:N(prop)`.