Skip to content

Commit 143ab8b

Browse files
authored
5.0-xrefs-to-links (#51) (#52)
* External xrefs to links * Update playbooks for docs links
1 parent 1d053ee commit 143ab8b

File tree

6 files changed

+22
-8
lines changed

6 files changed

+22
-8
lines changed

modules/ROOT/pages/actions/handling-errors.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If errors occur while executing statements, the server will roll back the transa
1414

1515
In this example, we send an invalid statement to the server in order to demonstrate error handling.
1616

17-
For more information on the status codes, see xref:4.4@status-codes:ROOT:index.adoc[Neo4j Status Codes].
17+
For more information on the status codes, see link:{neo4j-docs-base-uri}/status-codes/{page-version}[Neo4j Status Codes].
1818

1919
_Example request_
2020

modules/ROOT/pages/discovery.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The HTTP API uses the port `7474` for HTTP and the port `7473` for HTTPS.
77

88
[TIP]
99
====
10-
See the xref:4.4@operations-manual:ROOT:configuration/ports/index.adoc[Operations Manual -> Ports] for an overview of the Neo4j-specific ports.
10+
See the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/ports[Operations Manual -> Ports] for an overview of the Neo4j-specific ports.
1111
====
1212

1313

modules/ROOT/pages/introduction.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Each HTTP request can include a list of statements, and for convenience you can
99

1010
The server guards against orphaned transactions by using a timeout.
1111
If there are no requests for a given transaction within the timeout period, the server will roll it back.
12-
You can configure the timeout in the server configuration, by setting xref:4.4@operations-manual:ROOT:reference/configuration-settings/index.adoc#config_dbms.rest.transaction.idle_timeout[Operations Manual -> Configuration settings `dbms.rest.transaction.idle_timeout`] to the number of seconds before timeout.
12+
You can configure the timeout in the server configuration, by setting link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/configuration-settings#config_dbms.rest.transaction.idle_timeout[Operations Manual -> Configuration settings `dbms.rest.transaction.idle_timeout`] to the number of seconds before timeout.
1313
The default timeout is `60` seconds.
1414

1515
Responses from the HTTP API can be transmitted as JSON streams, resulting in better performance and lower memory overhead on the server side.
@@ -18,7 +18,7 @@ To use streaming, supply the header `X-Stream: true` with each request.
1818
[NOTE]
1919
====
2020
* Literal line breaks are not allowed inside Cypher statements.
21-
* Cypher queries with `USING PERIODIC COMMIT` (see xref:4.4@cypher-manual:ROOT:query-tuning/using/index.adoc#query-using-periodic-commit-hint[Cypher Manual -> `PERIODIC COMMIT` query hint]) may only be executed when creating a new transaction and immediately committing it with a single HTTP request (see xref::/actions/begin-and-commit-a-transaction-in-one-request.adoc[Begin and commit a transaction in one request] for how to do that).
21+
* Cypher queries with `USING PERIODIC COMMIT` (see link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/query-tuning/using#query-using-periodic-commit-hint[Cypher Manual -> `PERIODIC COMMIT` query hint]) may only be executed when creating a new transaction and immediately committing it with a single HTTP request (see xref::/actions/begin-and-commit-a-transaction-in-one-request.adoc[Begin and commit a transaction in one request] for how to do that).
2222
* When a request fails the transaction will be rolled back.
2323
By checking the result for the presence/absence of the `transaction` key you can figure out if the transaction is still open.
2424
====
@@ -27,6 +27,6 @@ By checking the result for the presence/absence of the `transaction` key you can
2727
====
2828
In order to speed up queries in repeated scenarios, try not to use literals but replace them with parameters wherever possible.
2929
This will let the server cache query plans.
30-
See xref:4.4@cypher-manual:ROOT:syntax/parameters/index.adoc#cypher-parameters[Cypher Manual -> Parameters] for more information.
30+
See link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/syntax/parameters#cypher-parameters[Cypher Manual -> Parameters] for more information.
3131
====
3232

modules/ROOT/pages/security/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[[http-api-security]]
44
= Authentication and authorization
55

6-
Authentication and authorization are enabled by default in Neo4j (refer to xref:4.4@operations-manual:ROOT:authentication-authorization/index.adoc#auth[Operations Manual -> Authentication and authorization]).
6+
Authentication and authorization are enabled by default in Neo4j (refer to link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization#auth[Operations Manual -> Authentication and authorization]).
77
With authentication and authorization enabled, requests to the HTTP API must be authorized using the username and password of a valid user.
88

99

preview.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,6 @@ asciidoc:
4444
experimental: ''
4545
copyright: 2022
4646
common-license-page-uri: https://neo4j.com/docs/license/
47+
# attributes for doc links to other manuals in preview playbook
48+
neo4j-base-uri: https://neo4j.com
49+
neo4j-docs-base-uri: https://neo4j.com/docs

publish.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,16 @@ asciidoc:
4949
includePDF: false
5050
nonhtmloutput: ""
5151
experimental: ''
52-
copyright: 2021
53-
common-license-page-uri: https://neo4j.com/docs/license/
52+
copyright: 2022
53+
common-license-page-uri: https://neo4j.com/docs/license/
54+
# attributes for doc links to other manuals in publish playbook
55+
neo4j-base-uri: ''
56+
neo4j-docs-base-uri: /docs
57+
# page-ad-image: https://dist.neo4j.com/wp-content/uploads/20220901150057/Artboard-12.png
58+
page-ad-overline-link: https://neo4j.com/nodes-2022
59+
page-ad-overline: 16-17 November 2022
60+
page-ad-title: NODES 2022
61+
page-ad-description: Join us for a free, two-day virtual conference of technical presentations by developers and data scientists, solving problems with graphs.
62+
page-ad-link: https://neo4j.com/nodes-2022
63+
page-ad-underline-role: button
64+
page-ad-underline: Save your space

0 commit comments

Comments
 (0)