Skip to content

Commit 6c5065f

Browse files
authored
Strip Tools section out and put the pages in the relevant places (neo4j#2213) (neo4j#2227)
Cherry-picked from neo4j#2213
1 parent 2515a43 commit 6c5065f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+108
-113
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,11 @@
8080
** xref:configuration/ports.adoc[]
8181
** xref:configuration/connectors.adoc[]
8282
** xref:configuration/set-initial-password.adoc[]
83+
** xref:configuration/neo4j-admin-memrec.adoc[]
8384
** xref:configuration/plugins.adoc[Plugins]
8485
** xref:configuration/dynamic-settings.adoc[]
86+
** xref:configuration/migrate-configuration.adoc[]
87+
** xref:configuration/validate-config.adoc[]
8588
** xref:configuration/configuration-settings.adoc[]
8689
*** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings]
8790
*** xref:configuration/configuration-settings.adoc#_cloud_storage_integration_settings[Cloud storage integration settings]
@@ -103,6 +106,8 @@
103106
*** xref:configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]
104107
*** xref:configuration/configuration-settings.adoc#_transaction_log_settings[Transaction log settings]
105108
109+
* xref:import.adoc[]
110+
106111
* xref:database-administration/index.adoc[]
107112
** xref:database-administration/syntax.adoc[]
108113
** Standard databases
@@ -112,6 +117,8 @@
112117
*** xref:database-administration/standard-databases/listing-databases.adoc[]
113118
*** xref:database-administration/standard-databases/alter-databases.adoc[]
114119
*** xref:database-administration/standard-databases/delete-databases.adoc[]
120+
*** xref:database-administration/standard-databases/migrate-database.adoc[]
121+
*** xref:database-administration/standard-databases/upload-to-aura.adoc[]
115122
*** xref:database-administration/standard-databases/wait-options.adoc[]
116123
*** xref:database-administration/standard-databases/configuration-parameters.adoc[]
117124
*** xref:database-administration/standard-databases/errors.adoc[]
@@ -135,6 +142,7 @@
135142
** xref:database-internals/transaction-logs.adoc[]
136143
** xref:database-internals/checkpointing.adoc[]
137144
** xref:database-internals/store-formats.adoc[]
145+
** xref:database-internals/neo4j-admin-store-info.adoc[]
138146
139147
* xref:clustering/index.adoc[]
140148
** xref:clustering/introduction.adoc[]
@@ -158,6 +166,7 @@
158166
** xref:clustering/server-syntax.adoc[]
159167
** xref:clustering/clustering-advanced/index.adoc[]
160168
*** xref:clustering/clustering-advanced/default-database.adoc[]
169+
*** xref:clustering/clustering-advanced/unbind.adoc[]
161170
*** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[]
162171
*** xref:clustering/clustering-advanced/reconciler.adoc[]
163172
** xref:clustering/glossary.adoc[]
@@ -168,6 +177,7 @@
168177
** xref:backup-restore/online-backup.adoc[]
169178
** xref:backup-restore/aggregate.adoc[]
170179
** xref:backup-restore/inspect.adoc[]
180+
** xref:backup-restore/consistency-checker.adoc[]
171181
** xref:backup-restore/restore-backup.adoc[]
172182
** xref:backup-restore/offline-backup.adoc[]
173183
** xref:backup-restore/restore-dump.adoc[]
@@ -221,23 +231,13 @@
221231
** xref:monitoring/query-management.adoc[]
222232
** xref:monitoring/connection-management.adoc[]
223233
** xref:monitoring/background-jobs.adoc[]
234+
** xref:monitoring/neo4j-admin-report.adoc[]
224235
// ** xref:monitoring/cluster/index.adoc[]
225236
// *** xref:monitoring/cluster/procedures.adoc[]
226237
// *** xref:monitoring/cluster/http-endpoints.adoc[]
227238
228-
* xref:tools/index.adoc[]
229-
** xref:tools/neo4j-admin/index.adoc[]
230-
*** xref:tools/neo4j-admin/consistency-checker.adoc[]
231-
*** xref:tools/neo4j-admin/neo4j-admin-report.adoc[]
232-
*** xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[]
233-
*** xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[]
234-
*** xref:tools/neo4j-admin/neo4j-admin-import.adoc[]
235-
*** xref:tools/neo4j-admin/unbind.adoc[]
236-
*** xref:tools/neo4j-admin/upload-to-aura.adoc[]
237-
*** xref:tools/neo4j-admin/migrate-database.adoc[]
238-
*** xref:tools/neo4j-admin/migrate-configuration.adoc[]
239-
*** xref:tools/neo4j-admin/validate-config.adoc[]
240-
** xref:tools/cypher-shell.adoc[]
239+
* xref:neo4j-admin-neo4j-cli.adoc[]
240+
* xref:cypher-shell.adoc[]
241241
242242
* xref:procedures.adoc[]
243243

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ server.default_listen_address=127.0.0.1
3636
+
3737
[NOTE]
3838
====
39-
Ensure, you have blocked all network connections for any individual services configured to listen to `listen_addresses`.
39+
Ensure, you have blocked all network connections for any individual services configured to listen to `listen_addresses`.
4040
====
4141
+
4242
. Start Neo4j:
@@ -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:tools/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:tools/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:tools/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/aggregate.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Aggregates a chain of backup artifacts into a single artifact.
6767
| Description
6868
| Default
6969

70-
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
70+
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
7171
|Configuration file with additional configuration.
7272
|
7373

modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc renamed to modules/ROOT/pages/backup-restore/consistency-checker.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:description: Describes the Neo4j consistency checker.
22
[[consistency-checker]]
3-
= Consistency checker
3+
= Check database consistency
44

55
You can use the `neo4j-admin database check` command to check the consistency of a database, a dump, or a backup.
66
The `neo4j-admin` tool is located in the _/bin_ directory.
@@ -68,7 +68,7 @@ The `neo4j-admin database check` command has the following options:
6868
|Allow command expansion in config value evaluation.
6969
|
7070

71-
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
71+
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
7272
| Configuration file with additional configuration.
7373
|
7474

modules/ROOT/pages/backup-restore/copy-database.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The `neo4j-admin database copy` command has the following options:
8181
| Description
8282
| Default
8383

84-
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
84+
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
8585
|Configuration file with additional configuration.
8686
|
8787

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This chapter describes the following:
99
* xref:backup-restore/online-backup.adoc[Back up an online database] -- How to back up an online database.
1010
* xref:backup-restore/aggregate.adoc[Aggregate a database backup chain] - How to aggregate a backup chain into a single backup.
1111
* xref:backup-restore/inspect.adoc[Inspect the metadata of a database backup file] -- How to inspect the metadata of a database backup file.
12+
* xref:backup-restore/consistency-checker.adoc[Check database consistency] -- How to check the consistency of a database, backup, or a dump.
1213
* xref:backup-restore/restore-backup.adoc[Restore a database backup] -- How to restore a database backup in a live Neo4j deployment.
1314
* xref:backup-restore/offline-backup.adoc[Back up an offline database] -- How to back up an offline database.
1415
* xref:backup-restore/restore-dump.adoc[Restore a database dump] -- How to restore a database dump in a live Neo4j deployment.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets,
6666
| Description
6767
| Default
6868

69-
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
69+
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
7070
|Configuration file with additional configuration.
7171
|
7272

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The `neo4j-admin database dump` command has the following options:
6565
| Description
6666
| Default
6767

68-
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
68+
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
6969
|Configuration file with additional configuration.
7070
|
7171

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
109109
| Description
110110
| Default
111111

112-
|--additional-config=<file>footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.]
112+
|--additional-config=<file>footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.]
113113
|Configuration file with additional configuration.
114114
|
115115

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:tools/neo4j-admin/index.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.

0 commit comments

Comments
 (0)