From 6ef008be034196143647793e51b559b380a6a9ef Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Mon, 17 Mar 2025 15:24:33 +0100 Subject: [PATCH 01/11] New Operations manual front page --- modules/ROOT/images/ga-home.svg | 373 ++++++++++++++++++++++ modules/ROOT/images/icon-admin.svg | 12 + modules/ROOT/images/icon-aura.svg | 3 + modules/ROOT/images/icon-cheatsheet.svg | 4 + modules/ROOT/images/icon-cloudstorage.svg | 7 + modules/ROOT/images/icon-developer.svg | 6 + modules/ROOT/images/icon-import.svg | 12 + modules/ROOT/images/icon-upgrade.svg | 10 + modules/ROOT/pages/index.adoc | 164 +++++++++- 9 files changed, 575 insertions(+), 16 deletions(-) create mode 100644 modules/ROOT/images/ga-home.svg create mode 100644 modules/ROOT/images/icon-admin.svg create mode 100644 modules/ROOT/images/icon-aura.svg create mode 100644 modules/ROOT/images/icon-cheatsheet.svg create mode 100644 modules/ROOT/images/icon-cloudstorage.svg create mode 100644 modules/ROOT/images/icon-developer.svg create mode 100644 modules/ROOT/images/icon-import.svg create mode 100644 modules/ROOT/images/icon-upgrade.svg diff --git a/modules/ROOT/images/ga-home.svg b/modules/ROOT/images/ga-home.svg new file mode 100644 index 000000000..88fad150e --- /dev/null +++ b/modules/ROOT/images/ga-home.svg @@ -0,0 +1,373 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/ROOT/images/icon-admin.svg b/modules/ROOT/images/icon-admin.svg new file mode 100644 index 000000000..e7ed8a215 --- /dev/null +++ b/modules/ROOT/images/icon-admin.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/modules/ROOT/images/icon-aura.svg b/modules/ROOT/images/icon-aura.svg new file mode 100644 index 000000000..bf5a4fe7d --- /dev/null +++ b/modules/ROOT/images/icon-aura.svg @@ -0,0 +1,3 @@ + + + diff --git a/modules/ROOT/images/icon-cheatsheet.svg b/modules/ROOT/images/icon-cheatsheet.svg new file mode 100644 index 000000000..22e66b098 --- /dev/null +++ b/modules/ROOT/images/icon-cheatsheet.svg @@ -0,0 +1,4 @@ + + + + diff --git a/modules/ROOT/images/icon-cloudstorage.svg b/modules/ROOT/images/icon-cloudstorage.svg new file mode 100644 index 000000000..3605f6cc9 --- /dev/null +++ b/modules/ROOT/images/icon-cloudstorage.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/modules/ROOT/images/icon-developer.svg b/modules/ROOT/images/icon-developer.svg new file mode 100644 index 000000000..a6af03229 --- /dev/null +++ b/modules/ROOT/images/icon-developer.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/modules/ROOT/images/icon-import.svg b/modules/ROOT/images/icon-import.svg new file mode 100644 index 000000000..f012fad01 --- /dev/null +++ b/modules/ROOT/images/icon-import.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/modules/ROOT/images/icon-upgrade.svg b/modules/ROOT/images/icon-upgrade.svg new file mode 100644 index 000000000..3b7f9045a --- /dev/null +++ b/modules/ROOT/images/icon-upgrade.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 3e6ac990f..ce863d15b 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,5 +1,12 @@ [[operations-manual]] -= The Neo4j Operations Manual += Neo4j operations +:page-layout: docs-ndl +:page-theme: docs +:page-role: hub +:page-show-home-link: true +:page-hide-nav-title: true +// :page-disablefeedback: true +:page-toclevels: -1 :neo4j-buildnumber: {neo4j-version} :download-center-uri: https://neo4j.com/deployment-center/ :lucene-version: 5_4_0 @@ -8,26 +15,151 @@ :console: 0 -This is the Neo4j Operations Manual, which includes all the operational details and instructions for installing and deploying Neo4j on-premise and in the cloud. +[.display.cards.selectable] -For all information on *upgrading and migrating Neo4j*, see the link:{neo4j-docs-base-uri}/upgrade-migration-guide/current/[Neo4j Upgrade and Migration Guide]. +== Manage and monitor your deployments -For more information on link:https://neo4j.com/aura/[Aura], the Neo4j fully managed cloud service, see the link:{neo4j-docs-base-uri}/aura[Neo4j Aura Manual]. +Find here details and instructions for installing and deploying Neo4j on-premise and in the cloud. +Follow tutorials and find administrative commands to help you manage and monitor your projects. +=== Installation -The latest version of Neo4j is *{neo4j-version-exact}*. +[.icon] +image:icon-import.svg[] -ifdef::backend-pdf[] -include::license.adoc[leveloffset=+1] -endif::[] +[.description] +Install Neo4j in different deployment contexts, such as Linux, macOS, and Windows. -ifdef::backend-html5[(C) {copyright}] -ifndef::backend-pdf[] +[.link] +xref:installation/index.adoc[] -Documentation license: link:{common-license-page-uri}[Creative Commons 4.0] -endif::[] -ifdef::backend-pdf[] -(C) {copyright} +[.cards] +=== Upgrade and migration -Documentation license: <> -endif::[] \ No newline at end of file +[.icon] +image:ROOT:icon-upgrade.svg[] + +[.description] +See information on how to upgrade or migrate self-managed Neo4j deployments. + +[.link] +xref:installation/index.adoc[] + +=== Aura instances + +[.icon] +image:ROOT:icon-aura.svg[] + +[.description] +See administrative options for fully managed cloud deployment. + +[.link] +xref:installation/index.adoc[] + +[.widget.lists] +== Tailored for you + +[.caption] +Keep exploring + +=== Neo4j admin commands + +[.icon] +image:icon-admin.svg[] + +[.list] +* xref:/tools/neo4j-admin/consistency-checker.adoc[`database check`] +* xref:/tools/neo4j-admin/neo4j-admin-report.adoc[`server report`] +* xref:/tools/neo4j-admin/neo4j-admin-store-info.adoc[`database info`] +* xref:/tools/neo4j-admin/neo4j-admin-memrec/[`server memory-recommendation`] +* xref:/tools/neo4j-admin/neo4j-admin-import/[`database import`] +* xref:/tools/neo4j-admin/unbind.adoc[`server unbind`] +* xref:/tools/neo4j-admin/upload-to-aura.adoc[`database upload`] +* xref:/tools/neo4j-admin/migrate-database.adoc[`database migrate`] +* xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] +* xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] +* xref:/backup-restore/online-backup.adoc[`database backup`] +* xref:/backup-restore/aggregate.adoc[`database aggregate`] +* xref:backup-restore/inspect.adoc[`backup inspect`] +* xref:/backup-restore/restore-backup.adoc[`database restore`] +* xref:/backup-restore/offline-backup.adoc[`database dump`] +* xref:/backup-restore/restore-dump.adoc[`database load`] +* xref:/backup-restore/copy-database.adoc[`database copy`] + +=== Cypher admin commands + +[.icon] +image:icon-developer.svg[] + +[.list] +* xref:database-administration/standard-databases/naming-databases.adoc[Manage standard databases] +* xref:database-administration/aliases/naming-aliases.adoc[Manage database aliases] +* xref:database-administration/composite-databases/concepts.adoc[Manage composite databases] +* xref:clustering/servers.adoc[Manage servers in a cluster] +* xref:clustering/databases.adoc[Manage databases in a cluster] +* xref:authentication-authorization/manage-users.adoc[Manage users] +* xref:authentication-authorization/manage-roles.adoc[Manage roles] +* xref:authentication-authorization/manage-privileges.adoc[Manage privileges] +* xref:authentication-authorization/built-in-roles.adoc[Built-in roles and privileges] +* xref:authentication-authorization/immutable-roles-privileges.adoc[Manage immutable roles and privileges] + +=== Reference + +[.icon] +image:icon-cheatsheet.svg[] + +[.list] +* xref:/configuration/configuration-settings.adoc[Configuration settings] +* xref:procedures.adoc[Procedures] +* xref:/monitoring/metrics/index.adoc[Metrics] +* xref:/database-administration/syntax.adoc[Database management commands syntax] +* xref:/clustering/server-syntax.adoc[Server management commands syntax] +* xref:/docker/ref-settings.adoc[Docker configuration settings conversion table] +* xref:/configuration/ports.adoc[Ports in Neo4j] +* xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] +* xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] + +=== Cloud object storage integration (COSI) + +[.icon] +image:icon-cloudstorage.svg[] + +[.list] +* Restore from the cloud +* Restore backup +* Load dump +* Import from the cloud +* Create from the cloud resource +* Seed from URI +* Upload a backup to the cloud + +[.widget.highlights] +== Tutorials & How-to guides + +[.icon] +image:ga-home.svg[] + +[.caption] +Tutorials and how-to guides + +[.list] +* xref:tutorial/neo4j-admin-import.adoc[Neo4j-admin import] +* xref:clustering/setup/deploy.adoc[Deploy a basic cluster] +* xref:clustering/setup/analytics-cluster.adoc[Deploy an analytics cluster] +* xref:/clustering/setup/discovery.adoc[Move from discovery service v1 to v2] +* xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] +* xref:tutorial/access-control.adoc[Fine-grained access control] +* xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] +* xref:tutorial/tutorial-sso-configuration.adoc[Configuring Neo4j Single Sign-On (SSO)] +* xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] +* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a Neo4j cluster in a Docker container] +* xref:kubernetes/quickstart-standalone/index.adoc[Deploy a standalone instance  using Helm charts] +* xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] +* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] + + +[.next-steps] +== Licenses and disclaimers + +[.link] +* link:https://neo4j.com/docs/license[Licenses and disclaimers] \ No newline at end of file From 3d867b7eee995cfcf0610adb99350b1a3271f560 Mon Sep 17 00:00:00 2001 From: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com> Date: Wed, 19 Mar 2025 11:46:38 +0100 Subject: [PATCH 02/11] Apply suggestions from code review Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/index.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index ce863d15b..dbf3dc309 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -19,7 +19,7 @@ == Manage and monitor your deployments -Find here details and instructions for installing and deploying Neo4j on-premise and in the cloud. +Find here details and instructions for installing and deploying Neo4j on-premises and in the cloud. Follow tutorials and find administrative commands to help you manage and monitor your projects. === Installation @@ -79,7 +79,7 @@ image:icon-admin.svg[] * xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] * xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] * xref:/backup-restore/online-backup.adoc[`database backup`] -* xref:/backup-restore/aggregate.adoc[`database aggregate`] +* xref:/backup-restore/aggregate.adoc[`backup aggregate`] * xref:backup-restore/inspect.adoc[`backup inspect`] * xref:/backup-restore/restore-backup.adoc[`database restore`] * xref:/backup-restore/offline-backup.adoc[`database dump`] From a65125818e44ed1c33a5efee9f2193250f2c8642 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Wed, 19 Mar 2025 11:53:45 +0100 Subject: [PATCH 03/11] Removing caption and adding Neo4j current version --- modules/ROOT/pages/index.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index dbf3dc309..9afd38f38 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -21,6 +21,7 @@ Find here details and instructions for installing and deploying Neo4j on-premises and in the cloud. Follow tutorials and find administrative commands to help you manage and monitor your projects. +The latest version of Neo4j is *{neo4j-version-exact}*. === Installation @@ -59,9 +60,6 @@ xref:installation/index.adoc[] [.widget.lists] == Tailored for you -[.caption] -Keep exploring - === Neo4j admin commands [.icon] From b4f068166ad4944e2e26a0fc2f1616e29771662b Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Wed, 19 Mar 2025 12:06:48 +0100 Subject: [PATCH 04/11] New option of the page --- modules/ROOT/images/icon-library.svg | 4 + modules/ROOT/pages/index.adoc | 121 ++++++++------------------- 2 files changed, 38 insertions(+), 87 deletions(-) create mode 100644 modules/ROOT/images/icon-library.svg diff --git a/modules/ROOT/images/icon-library.svg b/modules/ROOT/images/icon-library.svg new file mode 100644 index 000000000..f2d0beac4 --- /dev/null +++ b/modules/ROOT/images/icon-library.svg @@ -0,0 +1,4 @@ + + + + diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 9afd38f38..e84980d90 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -23,66 +23,28 @@ Find here details and instructions for installing and deploying Neo4j on-premise Follow tutorials and find administrative commands to help you manage and monitor your projects. The latest version of Neo4j is *{neo4j-version-exact}*. -=== Installation - -[.icon] -image:icon-import.svg[] - -[.description] -Install Neo4j in different deployment contexts, such as Linux, macOS, and Windows. - -[.link] -xref:installation/index.adoc[] - -[.cards] -=== Upgrade and migration - -[.icon] -image:ROOT:icon-upgrade.svg[] - -[.description] -See information on how to upgrade or migrate self-managed Neo4j deployments. - -[.link] -xref:installation/index.adoc[] - -=== Aura instances - -[.icon] -image:ROOT:icon-aura.svg[] - -[.description] -See administrative options for fully managed cloud deployment. - -[.link] -xref:installation/index.adoc[] - [.widget.lists] == Tailored for you -=== Neo4j admin commands +=== Tutorials and how-to guides [.icon] -image:icon-admin.svg[] +image:icon-library.svg[] [.list] -* xref:/tools/neo4j-admin/consistency-checker.adoc[`database check`] -* xref:/tools/neo4j-admin/neo4j-admin-report.adoc[`server report`] -* xref:/tools/neo4j-admin/neo4j-admin-store-info.adoc[`database info`] -* xref:/tools/neo4j-admin/neo4j-admin-memrec/[`server memory-recommendation`] -* xref:/tools/neo4j-admin/neo4j-admin-import/[`database import`] -* xref:/tools/neo4j-admin/unbind.adoc[`server unbind`] -* xref:/tools/neo4j-admin/upload-to-aura.adoc[`database upload`] -* xref:/tools/neo4j-admin/migrate-database.adoc[`database migrate`] -* xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] -* xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] -* xref:/backup-restore/online-backup.adoc[`database backup`] -* xref:/backup-restore/aggregate.adoc[`backup aggregate`] -* xref:backup-restore/inspect.adoc[`backup inspect`] -* xref:/backup-restore/restore-backup.adoc[`database restore`] -* xref:/backup-restore/offline-backup.adoc[`database dump`] -* xref:/backup-restore/restore-dump.adoc[`database load`] -* xref:/backup-restore/copy-database.adoc[`database copy`] +* xref:tutorial/neo4j-admin-import.adoc[Neo4j-admin import] +* xref:clustering/setup/deploy.adoc[Deploy a basic cluster] +* xref:clustering/setup/analytics-cluster.adoc[Deploy an analytics cluster] +* xref:/clustering/setup/discovery.adoc[Move from discovery service v1 to v2] +* xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] +* xref:tutorial/access-control.adoc[Fine-grained access control] +* xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] +* xref:tutorial/tutorial-sso-configuration.adoc[Configuring Neo4j Single Sign-On (SSO)] +* xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] +* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a Neo4j cluster in a Docker container] +* xref:kubernetes/quickstart-standalone/index.adoc[Deploy a standalone instance  using Helm charts] +* xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] +* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] === Cypher admin commands @@ -117,44 +79,29 @@ image:icon-cheatsheet.svg[] * xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] * xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] -=== Cloud object storage integration (COSI) - -[.icon] -image:icon-cloudstorage.svg[] - -[.list] -* Restore from the cloud -* Restore backup -* Load dump -* Import from the cloud -* Create from the cloud resource -* Seed from URI -* Upload a backup to the cloud - -[.widget.highlights] -== Tutorials & How-to guides +=== Neo4j admin commands [.icon] -image:ga-home.svg[] - -[.caption] -Tutorials and how-to guides +image:icon-admin.svg[] [.list] -* xref:tutorial/neo4j-admin-import.adoc[Neo4j-admin import] -* xref:clustering/setup/deploy.adoc[Deploy a basic cluster] -* xref:clustering/setup/analytics-cluster.adoc[Deploy an analytics cluster] -* xref:/clustering/setup/discovery.adoc[Move from discovery service v1 to v2] -* xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] -* xref:tutorial/access-control.adoc[Fine-grained access control] -* xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] -* xref:tutorial/tutorial-sso-configuration.adoc[Configuring Neo4j Single Sign-On (SSO)] -* xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] -* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a Neo4j cluster in a Docker container] -* xref:kubernetes/quickstart-standalone/index.adoc[Deploy a standalone instance  using Helm charts] -* xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] -* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] - +* xref:/tools/neo4j-admin/consistency-checker.adoc[`database check`] +* xref:/tools/neo4j-admin/neo4j-admin-report.adoc[`server report`] +* xref:/tools/neo4j-admin/neo4j-admin-store-info.adoc[`database info`] +* xref:/tools/neo4j-admin/neo4j-admin-memrec/[`server memory-recommendation`] +* xref:/tools/neo4j-admin/neo4j-admin-import/[`database import`] +* xref:/tools/neo4j-admin/unbind.adoc[`server unbind`] +* xref:/tools/neo4j-admin/upload-to-aura.adoc[`database upload`] +* xref:/tools/neo4j-admin/migrate-database.adoc[`database migrate`] +* xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] +* xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] +* xref:/backup-restore/online-backup.adoc[`database backup`] +* xref:/backup-restore/aggregate.adoc[`backup aggregate`] +* xref:backup-restore/inspect.adoc[`backup inspect`] +* xref:/backup-restore/restore-backup.adoc[`database restore`] +* xref:/backup-restore/offline-backup.adoc[`database dump`] +* xref:/backup-restore/restore-dump.adoc[`database load`] +* xref:/backup-restore/copy-database.adoc[`database copy`] [.next-steps] == Licenses and disclaimers From 691042e21d516c4098030d1b5e2c14e095f984c7 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Wed, 19 Mar 2025 12:07:44 +0100 Subject: [PATCH 05/11] Previous version for checking --- modules/ROOT/pages/index 2.adoc | 163 ++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 modules/ROOT/pages/index 2.adoc diff --git a/modules/ROOT/pages/index 2.adoc b/modules/ROOT/pages/index 2.adoc new file mode 100644 index 000000000..9afd38f38 --- /dev/null +++ b/modules/ROOT/pages/index 2.adoc @@ -0,0 +1,163 @@ +[[operations-manual]] += Neo4j operations +:page-layout: docs-ndl +:page-theme: docs +:page-role: hub +:page-show-home-link: true +:page-hide-nav-title: true +// :page-disablefeedback: true +:page-toclevels: -1 +:neo4j-buildnumber: {neo4j-version} +:download-center-uri: https://neo4j.com/deployment-center/ +:lucene-version: 5_4_0 +:lucene-version-printed: 5.4.0 +:lucene-base-uri: http://lucene.apache.org/core/{lucene-version} + +:console: 0 + +[.display.cards.selectable] + +== Manage and monitor your deployments + +Find here details and instructions for installing and deploying Neo4j on-premises and in the cloud. +Follow tutorials and find administrative commands to help you manage and monitor your projects. +The latest version of Neo4j is *{neo4j-version-exact}*. + +=== Installation + +[.icon] +image:icon-import.svg[] + +[.description] +Install Neo4j in different deployment contexts, such as Linux, macOS, and Windows. + +[.link] +xref:installation/index.adoc[] + +[.cards] +=== Upgrade and migration + +[.icon] +image:ROOT:icon-upgrade.svg[] + +[.description] +See information on how to upgrade or migrate self-managed Neo4j deployments. + +[.link] +xref:installation/index.adoc[] + +=== Aura instances + +[.icon] +image:ROOT:icon-aura.svg[] + +[.description] +See administrative options for fully managed cloud deployment. + +[.link] +xref:installation/index.adoc[] + +[.widget.lists] +== Tailored for you + +=== Neo4j admin commands + +[.icon] +image:icon-admin.svg[] + +[.list] +* xref:/tools/neo4j-admin/consistency-checker.adoc[`database check`] +* xref:/tools/neo4j-admin/neo4j-admin-report.adoc[`server report`] +* xref:/tools/neo4j-admin/neo4j-admin-store-info.adoc[`database info`] +* xref:/tools/neo4j-admin/neo4j-admin-memrec/[`server memory-recommendation`] +* xref:/tools/neo4j-admin/neo4j-admin-import/[`database import`] +* xref:/tools/neo4j-admin/unbind.adoc[`server unbind`] +* xref:/tools/neo4j-admin/upload-to-aura.adoc[`database upload`] +* xref:/tools/neo4j-admin/migrate-database.adoc[`database migrate`] +* xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] +* xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] +* xref:/backup-restore/online-backup.adoc[`database backup`] +* xref:/backup-restore/aggregate.adoc[`backup aggregate`] +* xref:backup-restore/inspect.adoc[`backup inspect`] +* xref:/backup-restore/restore-backup.adoc[`database restore`] +* xref:/backup-restore/offline-backup.adoc[`database dump`] +* xref:/backup-restore/restore-dump.adoc[`database load`] +* xref:/backup-restore/copy-database.adoc[`database copy`] + +=== Cypher admin commands + +[.icon] +image:icon-developer.svg[] + +[.list] +* xref:database-administration/standard-databases/naming-databases.adoc[Manage standard databases] +* xref:database-administration/aliases/naming-aliases.adoc[Manage database aliases] +* xref:database-administration/composite-databases/concepts.adoc[Manage composite databases] +* xref:clustering/servers.adoc[Manage servers in a cluster] +* xref:clustering/databases.adoc[Manage databases in a cluster] +* xref:authentication-authorization/manage-users.adoc[Manage users] +* xref:authentication-authorization/manage-roles.adoc[Manage roles] +* xref:authentication-authorization/manage-privileges.adoc[Manage privileges] +* xref:authentication-authorization/built-in-roles.adoc[Built-in roles and privileges] +* xref:authentication-authorization/immutable-roles-privileges.adoc[Manage immutable roles and privileges] + +=== Reference + +[.icon] +image:icon-cheatsheet.svg[] + +[.list] +* xref:/configuration/configuration-settings.adoc[Configuration settings] +* xref:procedures.adoc[Procedures] +* xref:/monitoring/metrics/index.adoc[Metrics] +* xref:/database-administration/syntax.adoc[Database management commands syntax] +* xref:/clustering/server-syntax.adoc[Server management commands syntax] +* xref:/docker/ref-settings.adoc[Docker configuration settings conversion table] +* xref:/configuration/ports.adoc[Ports in Neo4j] +* xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] +* xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] + +=== Cloud object storage integration (COSI) + +[.icon] +image:icon-cloudstorage.svg[] + +[.list] +* Restore from the cloud +* Restore backup +* Load dump +* Import from the cloud +* Create from the cloud resource +* Seed from URI +* Upload a backup to the cloud + +[.widget.highlights] +== Tutorials & How-to guides + +[.icon] +image:ga-home.svg[] + +[.caption] +Tutorials and how-to guides + +[.list] +* xref:tutorial/neo4j-admin-import.adoc[Neo4j-admin import] +* xref:clustering/setup/deploy.adoc[Deploy a basic cluster] +* xref:clustering/setup/analytics-cluster.adoc[Deploy an analytics cluster] +* xref:/clustering/setup/discovery.adoc[Move from discovery service v1 to v2] +* xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] +* xref:tutorial/access-control.adoc[Fine-grained access control] +* xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] +* xref:tutorial/tutorial-sso-configuration.adoc[Configuring Neo4j Single Sign-On (SSO)] +* xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] +* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a Neo4j cluster in a Docker container] +* xref:kubernetes/quickstart-standalone/index.adoc[Deploy a standalone instance  using Helm charts] +* xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] +* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] + + +[.next-steps] +== Licenses and disclaimers + +[.link] +* link:https://neo4j.com/docs/license[Licenses and disclaimers] \ No newline at end of file From 8ddb5a28111fdb86eecf93c55184c69763399e92 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Wed, 19 Mar 2025 12:09:08 +0100 Subject: [PATCH 06/11] changing file name --- modules/ROOT/pages/{index 2.adoc => version2.adoc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename modules/ROOT/pages/{index 2.adoc => version2.adoc} (100%) diff --git a/modules/ROOT/pages/index 2.adoc b/modules/ROOT/pages/version2.adoc similarity index 100% rename from modules/ROOT/pages/index 2.adoc rename to modules/ROOT/pages/version2.adoc From e22c36013ebfe84154c29d77941735781566a2c0 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Wed, 19 Mar 2025 13:16:57 +0100 Subject: [PATCH 07/11] new iteration of the frontpage --- modules/ROOT/images/icon-dbsettings.svg | 6 + modules/ROOT/images/icon-server.svg | 4 + modules/ROOT/pages/index.adoc | 107 ++++++++++------ modules/ROOT/pages/version2.adoc | 163 ------------------------ 4 files changed, 80 insertions(+), 200 deletions(-) create mode 100644 modules/ROOT/images/icon-dbsettings.svg create mode 100644 modules/ROOT/images/icon-server.svg delete mode 100644 modules/ROOT/pages/version2.adoc diff --git a/modules/ROOT/images/icon-dbsettings.svg b/modules/ROOT/images/icon-dbsettings.svg new file mode 100644 index 000000000..59beb75ad --- /dev/null +++ b/modules/ROOT/images/icon-dbsettings.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/modules/ROOT/images/icon-server.svg b/modules/ROOT/images/icon-server.svg new file mode 100644 index 000000000..90ba56bce --- /dev/null +++ b/modules/ROOT/images/icon-server.svg @@ -0,0 +1,4 @@ + + + + diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index e84980d90..7f1efc4e4 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -15,17 +15,14 @@ :console: 0 -[.display.cards.selectable] +[.display.cards] -== Manage and monitor your deployments +== Install, deploy and operate Neo4j in a self-managed environment -Find here details and instructions for installing and deploying Neo4j on-premises and in the cloud. -Follow tutorials and find administrative commands to help you manage and monitor your projects. +For information on upgrading and migrating Neo4j, see the link:https://neo4j.com/docs/upgrade-migration-guide/[Neo4j Upgrade and Migration] documentation. +For link:https://neo4j.com/aura/[Aura], the Neo4j fully managed cloud service, see the link:https://neo4j.com/docs/aura[Neo4j Aura] documentation. The latest version of Neo4j is *{neo4j-version-exact}*. -[.widget.lists] -== Tailored for you - === Tutorials and how-to guides [.icon] @@ -46,6 +43,22 @@ image:icon-library.svg[] * xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] * xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] +=== Reference + +[.icon] +image:icon-cheatsheet.svg[] + +[.list] +* xref:/configuration/configuration-settings.adoc[Configuration settings] +* xref:procedures.adoc[Procedures] +* xref:/monitoring/metrics/index.adoc[Metrics] +* xref:/database-administration/syntax.adoc[Database management commands syntax] +* xref:/clustering/server-syntax.adoc[Server management commands syntax] +* xref:/docker/ref-settings.adoc[Docker configuration settings conversion table] +* xref:/configuration/ports.adoc[Ports in Neo4j] +* xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] +* xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] + === Cypher admin commands [.icon] @@ -63,45 +76,65 @@ image:icon-developer.svg[] * xref:authentication-authorization/built-in-roles.adoc[Built-in roles and privileges] * xref:authentication-authorization/immutable-roles-privileges.adoc[Manage immutable roles and privileges] -=== Reference + +[.widget.lists] +== Tailored for you + +=== Neo4j Admin dbms commands [.icon] -image:icon-cheatsheet.svg[] +image:icon-admin.svg[] [.list] -* xref:/configuration/configuration-settings.adoc[Configuration settings] -* xref:procedures.adoc[Procedures] -* xref:/monitoring/metrics/index.adoc[Metrics] -* xref:/database-administration/syntax.adoc[Database management commands syntax] -* xref:/clustering/server-syntax.adoc[Server management commands syntax] -* xref:/docker/ref-settings.adoc[Docker configuration settings conversion table] -* xref:/configuration/ports.adoc[Ports in Neo4j] -* xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] -* xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] +* xref:configuration/set-initial-password.adoc[`neo4j-admin dbms set-initial-password`] +* `neo4j-admin dbms set-default-admin` +* `neo4j-admin dbms unbind-system-db` -=== Neo4j admin commands +=== Neo4j Admin server commands [.icon] -image:icon-admin.svg[] +image:icon-server.svg[] + +[.list] +* `neo4j-admin server console` +* `neo4j-admin server get-id` +* `neo4j-admin server license` +* xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[`neo4j-admin server memory-recommendation`] +* xref:tools/neo4j-admin/migrate-configuration.adoc[`neo4j-admin server migrate-configuration`] +* xref:tools/neo4j-admin/neo4j-admin-report.adoc[`neo4j-admin server report`] +* `neo4j-admin server restart` +* `neo4j-admin server start` +* `neo4j-admin server status` +* `neo4j-admin server stop` +* xref:tools/neo4j-admin/unbind.adoc[`neo4j-admin server unbind`] +* xref:/tools/neo4j-admin/validate-config.adoc[`neo4j-admin server validate-config`] +* `neo4j-admin server windows-service` + +=== Neo4j Admin database commands + +[.icon] +image:icon-dbsettings.svg[] + +[.list] +* xref:tools/neo4j-admin/consistency-checker.adoc[`neo4j-admin database check`] +* xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[`neo4j-admin database info`] +* xref:tools/neo4j-admin/neo4j-admin-import.adoc[`neo4j-admin database import`] +* xref:tools/neo4j-admin/upload-to-aura.adoc[`neo4j-admin database upload`] +* xref:tools/neo4j-admin/migrate-database.adoc[`neo4j-admin database migrate`] +* xref:backup-restore/copy-database.adoc[`neo4j-admin database copy`] + +=== Neo4j Admin database backup commands + +[.icon] +image:icon-import.svg[] [.list] -* xref:/tools/neo4j-admin/consistency-checker.adoc[`database check`] -* xref:/tools/neo4j-admin/neo4j-admin-report.adoc[`server report`] -* xref:/tools/neo4j-admin/neo4j-admin-store-info.adoc[`database info`] -* xref:/tools/neo4j-admin/neo4j-admin-memrec/[`server memory-recommendation`] -* xref:/tools/neo4j-admin/neo4j-admin-import/[`database import`] -* xref:/tools/neo4j-admin/unbind.adoc[`server unbind`] -* xref:/tools/neo4j-admin/upload-to-aura.adoc[`database upload`] -* xref:/tools/neo4j-admin/migrate-database.adoc[`database migrate`] -* xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] -* xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] -* xref:/backup-restore/online-backup.adoc[`database backup`] -* xref:/backup-restore/aggregate.adoc[`backup aggregate`] -* xref:backup-restore/inspect.adoc[`backup inspect`] -* xref:/backup-restore/restore-backup.adoc[`database restore`] -* xref:/backup-restore/offline-backup.adoc[`database dump`] -* xref:/backup-restore/restore-dump.adoc[`database load`] -* xref:/backup-restore/copy-database.adoc[`database copy`] +* xref:backup-restore/online-backup.adoc[`neo4j-admin database backup`] +* xref:backup-restore/aggregate.adoc[`neo4j-admin backup aggregate`] +* xref:backup-restore/inspect.adoc[`neo4j-admin backup inspect`] +* xref:backup-restore/restore-backup.adoc[`neo4j-admin database restore`] +* xref:backup-restore/offline-backup.adoc[`neo4j-admin database dump`] +* xref:backup-restore/restore-dump.adoc[`neo4j-admin database load`] [.next-steps] == Licenses and disclaimers diff --git a/modules/ROOT/pages/version2.adoc b/modules/ROOT/pages/version2.adoc deleted file mode 100644 index 9afd38f38..000000000 --- a/modules/ROOT/pages/version2.adoc +++ /dev/null @@ -1,163 +0,0 @@ -[[operations-manual]] -= Neo4j operations -:page-layout: docs-ndl -:page-theme: docs -:page-role: hub -:page-show-home-link: true -:page-hide-nav-title: true -// :page-disablefeedback: true -:page-toclevels: -1 -:neo4j-buildnumber: {neo4j-version} -:download-center-uri: https://neo4j.com/deployment-center/ -:lucene-version: 5_4_0 -:lucene-version-printed: 5.4.0 -:lucene-base-uri: http://lucene.apache.org/core/{lucene-version} - -:console: 0 - -[.display.cards.selectable] - -== Manage and monitor your deployments - -Find here details and instructions for installing and deploying Neo4j on-premises and in the cloud. -Follow tutorials and find administrative commands to help you manage and monitor your projects. -The latest version of Neo4j is *{neo4j-version-exact}*. - -=== Installation - -[.icon] -image:icon-import.svg[] - -[.description] -Install Neo4j in different deployment contexts, such as Linux, macOS, and Windows. - -[.link] -xref:installation/index.adoc[] - -[.cards] -=== Upgrade and migration - -[.icon] -image:ROOT:icon-upgrade.svg[] - -[.description] -See information on how to upgrade or migrate self-managed Neo4j deployments. - -[.link] -xref:installation/index.adoc[] - -=== Aura instances - -[.icon] -image:ROOT:icon-aura.svg[] - -[.description] -See administrative options for fully managed cloud deployment. - -[.link] -xref:installation/index.adoc[] - -[.widget.lists] -== Tailored for you - -=== Neo4j admin commands - -[.icon] -image:icon-admin.svg[] - -[.list] -* xref:/tools/neo4j-admin/consistency-checker.adoc[`database check`] -* xref:/tools/neo4j-admin/neo4j-admin-report.adoc[`server report`] -* xref:/tools/neo4j-admin/neo4j-admin-store-info.adoc[`database info`] -* xref:/tools/neo4j-admin/neo4j-admin-memrec/[`server memory-recommendation`] -* xref:/tools/neo4j-admin/neo4j-admin-import/[`database import`] -* xref:/tools/neo4j-admin/unbind.adoc[`server unbind`] -* xref:/tools/neo4j-admin/upload-to-aura.adoc[`database upload`] -* xref:/tools/neo4j-admin/migrate-database.adoc[`database migrate`] -* xref:/tools/neo4j-admin/migrate-configuration.adoc[`nserver migrate-configuration`] -* xref:/tools/neo4j-admin/validate-config.adoc[`server validate-config`] -* xref:/backup-restore/online-backup.adoc[`database backup`] -* xref:/backup-restore/aggregate.adoc[`backup aggregate`] -* xref:backup-restore/inspect.adoc[`backup inspect`] -* xref:/backup-restore/restore-backup.adoc[`database restore`] -* xref:/backup-restore/offline-backup.adoc[`database dump`] -* xref:/backup-restore/restore-dump.adoc[`database load`] -* xref:/backup-restore/copy-database.adoc[`database copy`] - -=== Cypher admin commands - -[.icon] -image:icon-developer.svg[] - -[.list] -* xref:database-administration/standard-databases/naming-databases.adoc[Manage standard databases] -* xref:database-administration/aliases/naming-aliases.adoc[Manage database aliases] -* xref:database-administration/composite-databases/concepts.adoc[Manage composite databases] -* xref:clustering/servers.adoc[Manage servers in a cluster] -* xref:clustering/databases.adoc[Manage databases in a cluster] -* xref:authentication-authorization/manage-users.adoc[Manage users] -* xref:authentication-authorization/manage-roles.adoc[Manage roles] -* xref:authentication-authorization/manage-privileges.adoc[Manage privileges] -* xref:authentication-authorization/built-in-roles.adoc[Built-in roles and privileges] -* xref:authentication-authorization/immutable-roles-privileges.adoc[Manage immutable roles and privileges] - -=== Reference - -[.icon] -image:icon-cheatsheet.svg[] - -[.list] -* xref:/configuration/configuration-settings.adoc[Configuration settings] -* xref:procedures.adoc[Procedures] -* xref:/monitoring/metrics/index.adoc[Metrics] -* xref:/database-administration/syntax.adoc[Database management commands syntax] -* xref:/clustering/server-syntax.adoc[Server management commands syntax] -* xref:/docker/ref-settings.adoc[Docker configuration settings conversion table] -* xref:/configuration/ports.adoc[Ports in Neo4j] -* xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] -* xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] - -=== Cloud object storage integration (COSI) - -[.icon] -image:icon-cloudstorage.svg[] - -[.list] -* Restore from the cloud -* Restore backup -* Load dump -* Import from the cloud -* Create from the cloud resource -* Seed from URI -* Upload a backup to the cloud - -[.widget.highlights] -== Tutorials & How-to guides - -[.icon] -image:ga-home.svg[] - -[.caption] -Tutorials and how-to guides - -[.list] -* xref:tutorial/neo4j-admin-import.adoc[Neo4j-admin import] -* xref:clustering/setup/deploy.adoc[Deploy a basic cluster] -* xref:clustering/setup/analytics-cluster.adoc[Deploy an analytics cluster] -* xref:/clustering/setup/discovery.adoc[Move from discovery service v1 to v2] -* xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] -* xref:tutorial/access-control.adoc[Fine-grained access control] -* xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] -* xref:tutorial/tutorial-sso-configuration.adoc[Configuring Neo4j Single Sign-On (SSO)] -* xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] -* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a Neo4j cluster in a Docker container] -* xref:kubernetes/quickstart-standalone/index.adoc[Deploy a standalone instance  using Helm charts] -* xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] -* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] - - -[.next-steps] -== Licenses and disclaimers - -[.link] -* link:https://neo4j.com/docs/license[Licenses and disclaimers] \ No newline at end of file From 7e912b82c51fd0eabb7c30cff2e3b74355864173 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Wed, 19 Mar 2025 13:22:39 +0100 Subject: [PATCH 08/11] fixing images and removing unused ones --- modules/ROOT/images/ga-home.svg | 373 ---------------------- modules/ROOT/images/icon-aura.svg | 3 - modules/ROOT/images/icon-cloudstorage.svg | 7 - modules/ROOT/images/icon-dbsettings.svg | 1 - modules/ROOT/images/icon-server.svg | 1 - modules/ROOT/images/icon-upgrade.svg | 10 - 6 files changed, 395 deletions(-) delete mode 100644 modules/ROOT/images/ga-home.svg delete mode 100644 modules/ROOT/images/icon-aura.svg delete mode 100644 modules/ROOT/images/icon-cloudstorage.svg delete mode 100644 modules/ROOT/images/icon-upgrade.svg diff --git a/modules/ROOT/images/ga-home.svg b/modules/ROOT/images/ga-home.svg deleted file mode 100644 index 88fad150e..000000000 --- a/modules/ROOT/images/ga-home.svg +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/modules/ROOT/images/icon-aura.svg b/modules/ROOT/images/icon-aura.svg deleted file mode 100644 index bf5a4fe7d..000000000 --- a/modules/ROOT/images/icon-aura.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/modules/ROOT/images/icon-cloudstorage.svg b/modules/ROOT/images/icon-cloudstorage.svg deleted file mode 100644 index 3605f6cc9..000000000 --- a/modules/ROOT/images/icon-cloudstorage.svg +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/modules/ROOT/images/icon-dbsettings.svg b/modules/ROOT/images/icon-dbsettings.svg index 59beb75ad..b5072daad 100644 --- a/modules/ROOT/images/icon-dbsettings.svg +++ b/modules/ROOT/images/icon-dbsettings.svg @@ -1,5 +1,4 @@ - diff --git a/modules/ROOT/images/icon-server.svg b/modules/ROOT/images/icon-server.svg index 90ba56bce..d799cd840 100644 --- a/modules/ROOT/images/icon-server.svg +++ b/modules/ROOT/images/icon-server.svg @@ -1,4 +1,3 @@ - diff --git a/modules/ROOT/images/icon-upgrade.svg b/modules/ROOT/images/icon-upgrade.svg deleted file mode 100644 index 3b7f9045a..000000000 --- a/modules/ROOT/images/icon-upgrade.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - From 6dcf49518eee1e13cd74e9686a1fcf9c4a09ad18 Mon Sep 17 00:00:00 2001 From: Lidia Zuin <102308961+lidiazuin@users.noreply.github.com> Date: Wed, 19 Mar 2025 14:47:58 +0100 Subject: [PATCH 09/11] Apply suggestions from code review Co-authored-by: Reneta Popova --- modules/ROOT/pages/index.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 7f1efc4e4..5358e73ba 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,5 +1,5 @@ [[operations-manual]] -= Neo4j operations += Neo4j Operations :page-layout: docs-ndl :page-theme: docs :page-role: hub @@ -23,7 +23,7 @@ For information on upgrading and migrating Neo4j, see the link:https://neo4j.com For link:https://neo4j.com/aura/[Aura], the Neo4j fully managed cloud service, see the link:https://neo4j.com/docs/aura[Neo4j Aura] documentation. The latest version of Neo4j is *{neo4j-version-exact}*. -=== Tutorials and how-to guides +=== How-tos and tutorials [.icon] image:icon-library.svg[] @@ -43,7 +43,7 @@ image:icon-library.svg[] * xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] * xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] -=== Reference +=== References [.icon] image:icon-cheatsheet.svg[] @@ -59,7 +59,7 @@ image:icon-cheatsheet.svg[] * xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] * xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] -=== Cypher admin commands +=== Cypher administration commands [.icon] image:icon-developer.svg[] @@ -80,7 +80,7 @@ image:icon-developer.svg[] [.widget.lists] == Tailored for you -=== Neo4j Admin dbms commands +=== DBMS commands [.icon] image:icon-admin.svg[] @@ -90,7 +90,7 @@ image:icon-admin.svg[] * `neo4j-admin dbms set-default-admin` * `neo4j-admin dbms unbind-system-db` -=== Neo4j Admin server commands +=== Server commands [.icon] image:icon-server.svg[] @@ -110,7 +110,7 @@ image:icon-server.svg[] * xref:/tools/neo4j-admin/validate-config.adoc[`neo4j-admin server validate-config`] * `neo4j-admin server windows-service` -=== Neo4j Admin database commands +=== Database commands [.icon] image:icon-dbsettings.svg[] @@ -123,7 +123,7 @@ image:icon-dbsettings.svg[] * xref:tools/neo4j-admin/migrate-database.adoc[`neo4j-admin database migrate`] * xref:backup-restore/copy-database.adoc[`neo4j-admin database copy`] -=== Neo4j Admin database backup commands +=== Database backup commands [.icon] image:icon-import.svg[] From 37d099e2e5bf23da390e329c798d0655a1ce51c0 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Thu, 20 Mar 2025 10:03:58 +0100 Subject: [PATCH 10/11] update after review --- modules/ROOT/pages/index.adoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 5358e73ba..024116bf5 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -19,8 +19,7 @@ == Install, deploy and operate Neo4j in a self-managed environment -For information on upgrading and migrating Neo4j, see the link:https://neo4j.com/docs/upgrade-migration-guide/[Neo4j Upgrade and Migration] documentation. -For link:https://neo4j.com/aura/[Aura], the Neo4j fully managed cloud service, see the link:https://neo4j.com/docs/aura[Neo4j Aura] documentation. +Neo4j Operations includes all the operational details and instructions for installing, deploying, and operating Neo4j in a self-managed environment. + The latest version of Neo4j is *{neo4j-version-exact}*. === How-tos and tutorials @@ -78,7 +77,7 @@ image:icon-developer.svg[] [.widget.lists] -== Tailored for you +== Neo4j Admin commands === DBMS commands From c2585579679c3e11be025a30d2f4fb03f6e80904 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Thu, 20 Mar 2025 12:21:05 +0100 Subject: [PATCH 11/11] Editorial and content updates --- modules/ROOT/pages/index.adoc | 50 +++++++++++++++-------------------- 1 file changed, 22 insertions(+), 28 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 024116bf5..d78d872b7 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -15,13 +15,13 @@ :console: 0 -[.display.cards] - -== Install, deploy and operate Neo4j in a self-managed environment +Neo4j Operations includes all the operational details and instructions for installing, deploying, and operating Neo4j in a self-managed environment. -Neo4j Operations includes all the operational details and instructions for installing, deploying, and operating Neo4j in a self-managed environment. + The latest version of Neo4j is *{neo4j-version-exact}*. +[.display.cards] +== References + === How-tos and tutorials [.icon] @@ -35,14 +35,14 @@ image:icon-library.svg[] * xref:/clustering/disaster-recovery.adoc[Disaster recovery guide] * xref:tutorial/access-control.adoc[Fine-grained access control] * xref:tutorial/tutorial-composite-database.adoc[Set up and use a composite database] -* xref:tutorial/tutorial-sso-configuration.adoc[Configuring Neo4j Single Sign-On (SSO)] +* xref:tutorial/tutorial-sso-configuration.adoc[Configure Neo4j Single Sign-On (SSO)] * xref:docker/docker-compose-standalone.adoc[Deploy Neo4j using Docker Compose] -* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a Neo4j cluster in a Docker container] -* xref:kubernetes/quickstart-standalone/index.adoc[Deploy a standalone instance  using Helm charts] +* xref:tutorial/tutorial-clustering-docker.adoc[Deploy a cluster in a Docker container] +* xref:kubernetes/quickstart-standalone/index.adoc[Deploy Neo4j using Helm charts] * xref:kubernetes/quickstart-cluster/index.adoc[Deploy a cluster using Helm charts] -* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy a Neo4j cluster using Helm charts] +* xref:kubernetes/quickstart-analytics-cluster.adoc[Deploy an analytical cluster using Helm charts] -=== References +=== Cheet sheets [.icon] image:icon-cheatsheet.svg[] @@ -58,7 +58,7 @@ image:icon-cheatsheet.svg[] * xref:/tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] * xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals] -=== Cypher administration commands +=== Cypher admin commands [.icon] image:icon-developer.svg[] @@ -76,35 +76,28 @@ image:icon-developer.svg[] * xref:authentication-authorization/immutable-roles-privileges.adoc[Manage immutable roles and privileges] -[.widget.lists] +[.display.cards] == Neo4j Admin commands -=== DBMS commands +=== DBMS and server commands [.icon] -image:icon-admin.svg[] +image:icon-server.svg[] [.list] * xref:configuration/set-initial-password.adoc[`neo4j-admin dbms set-initial-password`] * `neo4j-admin dbms set-default-admin` * `neo4j-admin dbms unbind-system-db` - -=== Server commands - -[.icon] -image:icon-server.svg[] - -[.list] -* `neo4j-admin server console` -* `neo4j-admin server get-id` -* `neo4j-admin server license` +// * `neo4j-admin server console` +// * `neo4j-admin server get-id` +// * `neo4j-admin server license` * xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[`neo4j-admin server memory-recommendation`] * xref:tools/neo4j-admin/migrate-configuration.adoc[`neo4j-admin server migrate-configuration`] * xref:tools/neo4j-admin/neo4j-admin-report.adoc[`neo4j-admin server report`] -* `neo4j-admin server restart` -* `neo4j-admin server start` -* `neo4j-admin server status` -* `neo4j-admin server stop` +// * `neo4j-admin server restart` +// * `neo4j-admin server start` +// * `neo4j-admin server status` +// * `neo4j-admin server stop` * xref:tools/neo4j-admin/unbind.adoc[`neo4j-admin server unbind`] * xref:/tools/neo4j-admin/validate-config.adoc[`neo4j-admin server validate-config`] * `neo4j-admin server windows-service` @@ -135,8 +128,9 @@ image:icon-import.svg[] * xref:backup-restore/offline-backup.adoc[`neo4j-admin database dump`] * xref:backup-restore/restore-dump.adoc[`neo4j-admin database load`] + [.next-steps] == Licenses and disclaimers [.link] -* link:https://neo4j.com/docs/license[Licenses and disclaimers] \ No newline at end of file +link:https://neo4j.com/docs/license[Licenses and disclaimers] \ No newline at end of file