Skip to content

Commit dde68a1

Browse files
Fix xref related syntax (#2349) (#2358)
Some leftovers to fix after restructuring the Tools section.
1 parent 6f4159b commit dde68a1

File tree

11 files changed

+17
-17
lines changed

11 files changed

+17
-17
lines changed

modules/ROOT/pages/authentication-authorization/password-and-user-recovery.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ bin/neo4j start
8686
[[password-recovery-for-admin]]
8787
== Recover a lost password
8888

89-
You can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and set a new password for the admin user.
89+
You can use a client such as xref:cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and set a new password for the admin user.
9090

9191
[NOTE]
9292
====
@@ -124,7 +124,7 @@ ALTER USER neo4j SET PASSWORD 'mynewpassword'
124124
[[recover-unassigned-admin-role]]
125125
== Recover an unassigned admin role
126126

127-
You can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and grant the admin user role to an existing user.
127+
You can use a client such as xref:cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and grant the admin user role to an existing user.
128128

129129
[NOTE]
130130
====
@@ -162,7 +162,7 @@ GRANT ROLE admin TO neo4j
162162
[[recover-admin-role]]
163163
== Recover the admin role
164164

165-
If you have removed the admin role from your system entirely, you can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and recreate the role with its original capabilities.
165+
If you have removed the admin role from your system entirely, you can use a client such as xref:cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and recreate the role with its original capabilities.
166166

167167
[NOTE]
168168
====

modules/ROOT/pages/backup-restore/planning.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This ensures that if for some reason your Neo4j DBMS crashes, you will be able t
5151
== Backup and restore options
5252

5353
Neo4j supports backing up and restoring both online and offline databases.
54-
It uses xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS.
54+
It uses xref:neo4j-admin-neo4j-cli.adoc[Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS.
5555
All `neo4j-admin` commands must be invoked as the `neo4j` user to ensure the appropriate file permissions.
5656

5757
* `neo4j-admin database backup/restore` (Enterprise only) -– used for performing online backup (xref:backup-restore/modes.adoc#full-backup[full] and xref:backup-restore/modes.adoc#differential-backup[differential]) and restore operations.

modules/ROOT/pages/configuration/file-locations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For the Neo4j's uses of the Java Native Access (JNA) library, set `server.jvm.ad
2424
[[neo4j-bin]]
2525
=== Bin
2626

27-
The _bin_ directory contains the Neo4j running script and built-in tools, such as xref:cypher-shell.adoc[][Cypher Shell] and xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin].
27+
The _bin_ directory contains the Neo4j running script and built-in tools, such as xref:cypher-shell.adoc[Cypher Shell] and xref:neo4j-admin-neo4j-cli.adoc[].
2828

2929
File permissions:: Read only and execute.
3030

modules/ROOT/pages/database-administration/queries.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[NOTE]
66
====
7-
All commands and example queries in this section are run in xref:cypher-shell.adoc[][the Neo4j Cypher Shell command-line interface (CLI)].
7+
All commands and example queries in this section are run in xref:cypher-shell.adoc[].
88
99
Note that the `cypher-shell` queries are not case-sensitive, but must end with a semicolon.
1010
====

modules/ROOT/pages/docker/operations.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can use the Neo4j tools when running Neo4j in a Docker container.
77
[[docker-neo4j-admin]]
88
== Use Neo4j Admin
99

10-
The xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin tool] can be run locally within a container using the following command:
10+
The xref:neo4j-admin-neo4j-cli.adoc[`neo4j-admin` CLI] can be run locally within a container using the following command:
1111

1212
[source, shell]
1313
----
@@ -16,7 +16,7 @@ docker exec --interactive --tty <containerID/name> neo4j-admin <category> <comma
1616

1717
To determine the container ID or name, run `docker ps` to list the currently running Docker containers.
1818

19-
For more information about the `neo4j-admin` commands, see xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin and Neo4j CLI].
19+
For more information about the `neo4j-admin` commands, see xref:neo4j-admin-neo4j-cli.adoc[].
2020

2121
[[docker-neo4j-import]]
2222
== Use Neo4j Import
@@ -67,7 +67,7 @@ neo4j-admin database import full --nodes=Movies=/import/movies_header.csv,/impor
6767
[[docker-neo4j-memrec]]
6868
== Use Neo4j Admin for memory recommendations
6969

70-
The xref:configuration/neo4j-admin-memrec.adoc[][neo4j-admin server memory-recommendation] command with the argument `--docker` outputs environmental variables that can be passed to a Neo4j docker container.
70+
The xref:configuration/neo4j-admin-memrec.adoc[neo4j-admin server memory-recommendation] command with the argument `--docker` outputs environmental variables that can be passed to a Neo4j docker container.
7171
The following example shows how `neo4j-admin server memory-recommendation --docker` provides a memory recommendation in a docker-friendly format.
7272

7373
.Invoke `neo4j-admin server memory-recommendation --docker`
@@ -142,7 +142,7 @@ The `$HOME/neo4j/reports` folder should now contain a zip file of reports.
142142
[[docker-cypher-shell]]
143143
== Use Cypher Shell
144144

145-
The xref:cypher-shell.adoc[][Neo4j Cypher Shell tool] can be run locally within a container using the following command:
145+
The xref:cypher-shell.adoc[] can be run locally within a container using the following command:
146146

147147
[source, shell]
148148
----

modules/ROOT/pages/installation/linux/debian.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ If you cannot reach `https://debian.neo4j.com`, perhaps due to a firewall, you n
140140

141141
[NOTE]
142142
====
143-
It is important to note that using this method will mean that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using `apt` for installing Neo4j; xref:cypher-shell.adoc[][Cypher Shell] and Java (if not installed already):
143+
It is important to note that using this method will mean that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using `apt` for installing Neo4j; xref:cypher-shell.adoc[Cypher Shell] and Java (if not installed already):
144144
145145
* The Cypher Shell package can be downloaded from {neo4j-download-center-uri}[Neo4j Deployment Center].
146146
* For information on supported versions of Java, see xref:installation/requirements.adoc[System requirements].

modules/ROOT/pages/installation/linux/rpm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ If you cannot reach `\https://yum.neo4j.com/stable/{neo4j-version}` to install N
139139

140140
[NOTE]
141141
====
142-
It is important to note that using this method means that the offline machine cannot receive the dependencies that are normally downloaded and installed automatically when using `yum` for installing Neo4j, xref:cypher-shell.adoc[][Neo4j Cypher Shell], and Java.
142+
It is important to note that using this method means that the offline machine cannot receive the dependencies that are normally downloaded and installed automatically when using `yum` for installing Neo4j, xref:cypher-shell.adoc[Neo4j Cypher Shell], and Java.
143143
====
144144

145145
. Download the Neo4j and Cypher Shell RPM installers from https://neo4j.com/deployment-center/[Deployment Center] or run the following to obtain the required packages:

modules/ROOT/pages/introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ a| link:https://neo4j.com/docs/cdc/current/[Change Data Capture (CDC)]
130130
|
131131
|
132132

133-
| xref:cypher-shell.adoc[][Cypher Shell]
133+
| xref:cypher-shell.adoc[Cypher Shell]
134134
| {check-mark}
135135
| {check-mark}
136136

modules/ROOT/pages/performance/memory-configuration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,13 @@ Otherwise, Neo4j computes some heuristic values at startup based on the availabl
9696
[discrete]
9797
[[memory-configuration-initial]]
9898
Initial memory recommendation::
99-
Use the `xref:configuration/neo4j-admin-memrec.adoc[][neo4j-admin server memory-recommendation]` command to get an initial recommendation for how to distribute a certain amount of memory.
99+
Use the xref:configuration/neo4j-admin-memrec.adoc[`neo4j-admin server memory-recommendation`] command to get an initial recommendation for how to distribute a certain amount of memory.
100100
The values may need to be adjusted to cater for each specific use case.
101101

102102
[discrete]
103103
[[memory-configuration-database]]
104104
Inspect the memory settings of all databases in a DBMS::
105-
The `xref:configuration/neo4j-admin-memrec.adoc[][neo4j-admin server memory-recommendation]` command is useful for inspecting the current distribution of data and indexes.
105+
The xref:configuration/neo4j-admin-memrec.adoc[`neo4j-admin server memory-recommendation`] command is useful for inspecting the current distribution of data and indexes.
106106
+
107107
.Use `neo4j-admin server memory-recommendation` to inspect the memory settings of all your databases
108108
====

modules/ROOT/pages/tutorial/neo4j-admin-import.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ They use:
2626
* The _import_ directory of the Neo4j installation to store all the CSV files.
2727
However, the CSV files can be located in any directory of your file system.
2828
* UNIX-styled paths.
29-
* The xref:neo4j-admin-neo4j-cli.adoc[][`neo4j-admin database import`] command.
29+
* The xref:import.adoc[`neo4j-admin database import`] command.
3030

3131
//To create a cluster based on imported data, see <<causal-clustering-seed-import>>.
3232

modules/ROOT/pages/tutorial/tutorial-composite-database.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Note that Cypher queries must end with a semicolon.
131131
+
132132
[NOTE]
133133
====
134-
For more information about the Cypher Shell command-line interface (CLI) and how to use it, see xref:cypher-shell.adoc[][].
134+
For more information about the Cypher Shell command-line interface (CLI) and how to use it, see xref:cypher-shell.adoc[].
135135
====
136136
. Run the command `SHOW DATABASES` to list all available databases:
137137
+

0 commit comments

Comments
 (0)