Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/docs-deploy-surge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
surge ./site ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}

- name: Comment on PR
uses: marocchino/sticky-pull-request-comment@v3
uses: marocchino/sticky-pull-request-comment@v2
with:
number: ${{ steps.get-deploy-id.outputs.deploy-id }}
message: |
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ name: "Verify PR"
on:
pull_request:
branches:
- main
- dev
- "4.4"
- "5.0"
- "5.x"
- "dev"

jobs:

Expand Down
5 changes: 2 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
= Documentation Template

This repo contains the files that you need to start a new Neo4j documentation project.
= Operations manual
This repo contains the Neo4j Operations manual source files.

== Prereqs

Expand Down
13 changes: 9 additions & 4 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
name: docs-template
title: Neo4j Documentation template
version: '1.0'
# display_version: '1.0-preview'
name: operations-manual
title: Operations Manual
version: '4.4'
start_page: ROOT:index.adoc
nav:
- modules/ROOT/content-nav.adoc
asciidoc:
attributes:
neo4j-version: '4.4'
neo4j-version-exact: '4.4.9'
neo4j-buildnumber: '4.4'
neo4j-debian-package-version: 1:4.4.9@
193 changes: 191 additions & 2 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,192 @@
* xref:index.adoc[]
* xref:getting-started.adoc[]
* xref:content-types.adoc[]
* xref:introduction.adoc[]
* xref:installation/index.adoc[]
** xref:installation/requirements.adoc[]
** xref:installation/neo4j-browser.adoc[]
** xref:installation/neo4j-desktop.adoc[]
** xref:installation/linux/index.adoc[]
*** xref:installation/linux/debian.adoc[]
*** xref:installation/linux/rpm.adoc[]
*** xref:installation/linux/tarball.adoc[]
*** xref:installation/linux/systemd.adoc[]
** xref:installation/osx.adoc[]
** xref:installation/windows.adoc[]

* xref:cloud-deployments/index.adoc[]
** xref:cloud-deployments/neo4j-aws.adoc[]
** xref:cloud-deployments/neo4j-gcp/index.adoc[]
*** xref:cloud-deployments/neo4j-gcp/single-instance-vm.adoc[]
*** xref:cloud-deployments/neo4j-gcp/causal-cluster-vm.adoc[]
*** xref:cloud-deployments/neo4j-gcp/automation-gcp.adoc[]
** xref:cloud-deployments/neo4j-azure/index.adoc[]
*** xref:cloud-deployments/neo4j-azure/single-instance-azure.adoc[]
*** xref:cloud-deployments/neo4j-azure/causal-cluster-azure.adoc[]
*** xref:cloud-deployments/neo4j-azure/automation-azure.adoc[]

* xref:docker/index.adoc[]
** xref:docker/introduction.adoc[]
** xref:docker/configuration.adoc[]
** xref:docker/clustering.adoc[]
** xref:docker/operations.adoc[]
** xref:docker/security.adoc[]
** xref:docker/maintenance.adoc[]
** xref:docker/ref-settings.adoc[]

* xref:kubernetes/index.adoc[Kubernetes]
** xref:kubernetes/introduction.adoc[Introduction]
** xref:kubernetes/helm-charts-setup.adoc[Configure the Neo4j Helm Chart repository]
** xref:kubernetes/quickstart-standalone/index.adoc[Quickstart: Deploy a standalone instance]
*** xref:kubernetes/quickstart-standalone/server-setup.adoc[Neo4j Helm Charts for standalone server deployment]
*** xref:kubernetes/quickstart-standalone/prerequisites.adoc[Prerequisites]
*** xref:kubernetes/quickstart-standalone/create-pv.adoc[Create a persistent volume]
*** xref:kubernetes/quickstart-standalone/create-value-file.adoc[Create a value.yaml file]
*** xref:kubernetes/quickstart-standalone/install-neo4j.adoc[Install a Neo4j standalone instance]
*** xref:kubernetes/quickstart-standalone/verify-installation.adoc[Verify the Neo4j installation]
*** xref:kubernetes/quickstart-standalone/uninstall-cleanup.adoc[Uninstall Neo4j and clean up]
** xref:kubernetes/quickstart-cluster/index.adoc[Quickstart: Deploy a cluster]
*** xref:kubernetes/quickstart-cluster/server-setup.adoc[Neo4j Helm Charts for cluster deployments]
*** xref:kubernetes/quickstart-cluster/prerequisites.adoc[Prerequisites]
*** xref:kubernetes/quickstart-cluster/create-pv.adoc[Create a persistent volume for each cluster member]
*** xref:kubernetes/quickstart-cluster/create-value-file.adoc[Create Helm deployment values files]
*** xref:kubernetes/quickstart-cluster/install-cores.adoc[Install Neo4j core members]
*** xref:kubernetes/quickstart-cluster/verify-cluster-formation.adoc[Verify the Neo4j cluster formation]
*** xref:kubernetes/quickstart-cluster/install-read-replicas.adoc[Install Neo4j read replicas]
*** xref:kubernetes/quickstart-cluster/verify-rr-joined.adoc[Verify the read replica has joined the cluster]
*** xref:kubernetes/quickstart-cluster/access-inside-k8s.adoc[Access the Neo4j cluster from inside Kubernetes]
*** xref:kubernetes/quickstart-cluster/access-outside-k8s.adoc[Access the Neo4j cluster from outside Kubernetes]
*** xref:kubernetes/quickstart-cluster/uninstall-cleanup.adoc[Uninstall Neo4j cluster and clean up]
** xref:kubernetes/configuration.adoc[Configure a Neo4j Helm deployment]
** xref:kubernetes/persistent-volumes.adoc[Volume mounts and persistent volumes]
** xref:kubernetes/accessing-neo4j.adoc[Access a Neo4j standalone server]
** xref:kubernetes/accessing-cluster.adoc[Access a Neo4j cluster]
** xref:kubernetes/import-data.adoc[Import data]
** xref:kubernetes/monitoring.adoc[Monitoring]
** xref:kubernetes/maintenance.adoc[Operations]
** Deploy a multi-data center Neo4j cluster
*** xref:kubernetes/multi-dc-cluster/aks.adoc[Deploy a single Neo4j cluster across multiple AKS clusters]
** xref:kubernetes/troubleshooting.adoc[Troubleshooting]

* xref:configuration/index.adoc[]
** xref:configuration/neo4j-conf.adoc[]
** xref:configuration/file-locations.adoc[]
//** xref:configuration/network-architecture.adoc[]
** xref:configuration/ports.adoc[]
** xref:configuration/connectors.adoc[]
** xref:configuration/set-initial-password.adoc[]
** xref:configuration/password-and-user-recovery.adoc[]
** xref:configuration/dynamic-settings.adoc[]
** xref:configuration/transaction-logs.adoc[]

* xref:manage-databases/index.adoc[]
** xref:manage-databases/introduction.adoc[]
** xref:manage-databases/configuration.adoc[]
** xref:manage-databases/queries.adoc[]
** xref:manage-databases/errors.adoc[]
** xref:manage-databases/causal-cluster.adoc[]
** xref:manage-databases/remote-alias.adoc[]

* xref:clustering/index.adoc[]
** xref:clustering/introduction.adoc[]
** xref:clustering/deploy.adoc[]
** xref:clustering/seed.adoc[]
** xref:clustering/discovery.adoc[]
** xref:clustering/intra-cluster-encryption.adoc[]
** xref:clustering/internals.adoc[]
** xref:clustering/settings.adoc[]

* xref:fabric/index.adoc[]
** xref:fabric/introduction.adoc[]
** xref:fabric/configuration.adoc[]
** xref:fabric/queries.adoc[]
** xref:fabric/considerations.adoc[]
** xref:fabric/sharding-with-copy.adoc[]

* xref:backup-restore/index.adoc[]
** xref:backup-restore/planning.adoc[]
** xref:backup-restore/modes.adoc[]
** xref:backup-restore/online-backup.adoc[]
** xref:backup-restore/prepare-restore.adoc[]
** xref:backup-restore/restore-backup.adoc[]
** xref:backup-restore/offline-backup.adoc[]
** xref:backup-restore/restore-dump.adoc[]
** xref:backup-restore/copy-database.adoc[]

* xref:authentication-authorization/index.adoc[]
** xref:authentication-authorization/introduction.adoc[]
** xref:authentication-authorization/built-in-roles.adoc[]
** xref:authentication-authorization/access-control.adoc[]
** xref:authentication-authorization/ldap-integration.adoc[]
** xref:authentication-authorization/sso-integration.adoc[]
** xref:authentication-authorization/manage-execute-permissions.adoc[]
** xref:authentication-authorization/terminology.adoc[]

* xref:security/index.adoc[]
** xref:security/securing-extensions.adoc[]
** xref:security/ssl-framework.adoc[]
** xref:security/browser.adoc[]
** xref:security/checklist.adoc[]

* xref:performance/index.adoc[]
** xref:performance/memory-configuration.adoc[]
** xref:performance/index-configuration.adoc[]
** xref:performance/gc-tuning.adoc[]
** xref:performance/bolt-thread-pool-configuration.adoc[]
** xref:performance/linux-file-system-tuning.adoc[]
** xref:performance/disks-ram-and-other-tips.adoc[]
** xref:performance/statistics-execution-plans.adoc[]
** xref:performance/space-reuse.adoc[]

* xref:monitoring/index.adoc[]
** xref:monitoring/logging.adoc[]
** xref:monitoring/metrics/index.adoc[]
*** xref:monitoring/metrics/essential.adoc[]
*** xref:monitoring/metrics/enable.adoc[]
*** xref:monitoring/metrics/expose.adoc[]
*** xref:monitoring/metrics/reference.adoc[]
** xref:monitoring/query-management.adoc[]
** xref:monitoring/transaction-management.adoc[]
** xref:monitoring/connection-management.adoc[]
** xref:monitoring/background-jobs.adoc[]
** xref:monitoring/causal-cluster/index.adoc[]
*** xref:monitoring/causal-cluster/procedures.adoc[]
*** xref:monitoring/causal-cluster/http-endpoints.adoc[]
** xref:monitoring/individual-db-states.adoc[]

* xref:tools/index.adoc[]
** xref:tools/cli-commands.adoc[]
** xref:tools/neo4j-admin/index.adoc[]
*** xref:tools/neo4j-admin/consistency-checker.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-report.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[]
*** xref:tools/neo4j-admin/neo4j-admin-import.adoc[]
*** xref:tools/neo4j-admin/unbind.adoc[]
*** xref:tools/neo4j-admin/push-to-cloud.adoc[]
** xref:tools/cypher-shell.adoc[]

* Appendix
** xref:reference/index.adoc[]
*** xref:reference/configuration-settings.adoc[]
*** xref:reference/procedures.adoc[]

** xref:tutorial/index.adoc[]
*** xref:tutorial/local-causal-cluster.adoc[]
*** xref:tutorial/causal-backup-restore-db.adoc[]
*** xref:tutorial/neo4j-admin-import.adoc[]
*** xref:tutorial/fabric-tutorial.adoc[]
*** xref:tutorial/tutorial-sso-configuration.adoc[]

** xref:clustering-advanced/index.adoc[]
*** xref:clustering-advanced/lifecycle.adoc[]
*** xref:clustering-advanced/multi-data-center/index.adoc[]
*** xref:clustering-advanced/multi-data-center/design.adoc[]
*** xref:clustering-advanced/multi-data-center/configuration.adoc[]
*** xref:clustering-advanced/multi-data-center/load-balancing.adoc[]
*** xref:clustering-advanced/multi-data-center/disaster-recovery.adoc[]
** xref:clustering-advanced/embedded.adoc[]

** xref:deprecated-security-procedures/index.adoc[]
*** xref:deprecated-security-procedures/enterprise-edition.adoc[]
*** xref:deprecated-security-procedures/community-edition.adoc[]

** xref:routing-decisions.adoc[]
2 changes: 0 additions & 2 deletions modules/ROOT/examples/example.csv

This file was deleted.

Loading