Skip to content
Closed
12 changes: 12 additions & 0 deletions modules/ROOT/images/icon-admin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions modules/ROOT/images/icon-cheatsheet.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions modules/ROOT/images/icon-dbsettings.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions modules/ROOT/images/icon-developer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions modules/ROOT/images/icon-import.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions modules/ROOT/images/icon-library.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions modules/ROOT/images/icon-server.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
142 changes: 126 additions & 16 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -8,26 +15,129 @@

: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]

For all information on *upgrading and migrating Neo4j*, see the link:{neo4j-docs-base-uri}/upgrade-migration-guide/current/[Neo4j Upgrade and Migration Guide].
== Install, deploy and operate Neo4j in a self-managed environment
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much better now.
However, I still think that having an intro sentence looks better than starting with "For more information...". If we have to remove something, then let's remove these two sentences:
"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."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean keeping only the info about the current Neo4j version then?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I mean removing this heading: Install, deploy and operate Neo4j in a self-managed environment and having a sentence instead like I already suggested:

Suggested change
== 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.
The latest version of Neo4j is *{neo4j-version-exact}*.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add the introductory sentence, but the layout has this formatting and we should stick to a more standardizing approach.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But who created this layout? Can't we amend it to suit our needs? Or we can have slightly different layouts for different needs/manuals?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sebastian from the design team created this, DocOps executes it. We can make amends when necessary for a functional reason, which I believe it's not the case here. We need to make sure we follow a standard and create consistency across all docsets.


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].
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}*.

=== Tutorials and how-to guides

The latest version of Neo4j is *{neo4j-version-exact}*.
[.icon]
image:icon-library.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]

=== 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]
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]


[.widget.lists]
== Tailored for you

=== Neo4j Admin dbms commands

[.icon]
image:icon-admin.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`

=== Neo4j Admin server commands

[.icon]
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

ifdef::backend-pdf[]
include::license.adoc[leveloffset=+1]
endif::[]
[.icon]
image:icon-import.svg[]

ifdef::backend-html5[(C) {copyright}]
ifndef::backend-pdf[]
[.list]
* 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`]

Documentation license: link:{common-license-page-uri}[Creative Commons 4.0]
endif::[]
ifdef::backend-pdf[]
(C) {copyright}
[.next-steps]
== Licenses and disclaimers

Documentation license: <<license, Creative Commons 4.0>>
endif::[]
[.link]
* link:https://neo4j.com/docs/license[Licenses and disclaimers]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* link:https://neo4j.com/docs/license[Licenses and disclaimers]
Documentation license: link:https://neo4j.com/docs/reference/license/#_creative_commons[Creative Commons 4.0]

I am not sure if that will work, but my idea is to remove the heading and add the exact link.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The standard for all pages is this one, we need to keep the whole link for legal reasons

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'll speak with David about it and let you know.