diff --git a/doc/modules/ROOT/content-nav.adoc b/doc/modules/ROOT/content-nav.adoc index 04132ae9d7..45f799b388 100644 --- a/doc/modules/ROOT/content-nav.adoc +++ b/doc/modules/ROOT/content-nav.adoc @@ -1,6 +1,6 @@ * xref:index.adoc[] * xref:introduction.adoc[] -* xref:installation/index.adoc[] +* xref:installation/installation.adoc[] ** xref:installation/supported-neo4j-versions.adoc[] ** xref:installation/neo4j-desktop.adoc[] ** xref:installation/neo4j-server.adoc[] diff --git a/doc/modules/ROOT/pages/getting-started/index.adoc b/doc/modules/ROOT/pages/getting-started/index.adoc index 424acd9199..a4e5c6a6ec 100644 --- a/doc/modules/ROOT/pages/getting-started/index.adoc +++ b/doc/modules/ROOT/pages/getting-started/index.adoc @@ -3,7 +3,7 @@ :description: This chapter gives users the basic information to start using the Neo4j Graph Data Science library. :keywords: GDS, getting started -After xref:installation/index.adoc[installation], you can start using the GDS library in two main ways: +After xref:installation/installation.adoc[installation], you can start using the GDS library in two main ways: * To run one or more algorithms on an in-memory graph, inspect the result of the computation, and potentially write it back to Neo4j. * To configure a machine learning pipeline and use it to train a model, then use the model for prediction. @@ -43,4 +43,4 @@ The typical workflow with a machine learning pipeline in GDS is as follows: image::pipeline-model.svg["Workflow of pipelines and models.", 400] -The xref:getting-started/ml-pipeline.adoc[] example shows how to configure and use a basic Link Prediction pipeline. \ No newline at end of file +The xref:getting-started/ml-pipeline.adoc[] example shows how to configure and use a basic Link Prediction pipeline. diff --git a/doc/modules/ROOT/pages/index.adoc b/doc/modules/ROOT/pages/index.adoc index 7513e9c33f..f413b3b6c3 100644 --- a/doc/modules/ROOT/pages/index.adoc +++ b/doc/modules/ROOT/pages/index.adoc @@ -24,7 +24,7 @@ endif::[] The manual covers the following areas: * xref:introduction.adoc[Introduction] -- An introduction to the Neo4j Graph Data Science library. -* xref:installation/index.adoc[Installation] -- Instructions for how to install and use the Neo4j Graph Data Science library. +* xref:installation/installation.adoc[Installation] -- Instructions for how to install and use the Neo4j Graph Data Science library. * xref:common-usage/index.adoc[Common usage] -- General usage patterns and recommendations for getting the most out of the Neo4j Graph Data Science library. * xref:management-ops/index.adoc[Graph management] -- A detailed guide to the graph catalog and utility procedures included in the Neo4j Graph Data Science library. * xref:algorithms/index.adoc[Graph algorithms] -- A detailed guide to each algorithm in their respective categories, including use-cases and examples. diff --git a/doc/modules/ROOT/pages/installation/index.adoc b/doc/modules/ROOT/pages/installation/installation.adoc similarity index 100% rename from doc/modules/ROOT/pages/installation/index.adoc rename to doc/modules/ROOT/pages/installation/installation.adoc diff --git a/doc/modules/ROOT/pages/operations-reference/additional-operation-references.adoc b/doc/modules/ROOT/pages/operations-reference/additional-operation-references.adoc index 8c4f526619..0f96f2765e 100644 --- a/doc/modules/ROOT/pages/operations-reference/additional-operation-references.adoc +++ b/doc/modules/ROOT/pages/operations-reference/additional-operation-references.adoc @@ -9,10 +9,10 @@ .2+<.^| xref:management-ops/utility-functions.adoc[The version of the installed GDS] | `gds.version` label:procedure[Procedure] | `gds.version` label:function[Function] -| xref:installation/index.adoc#_verifying_the_installation[List all operations in GDS] | `gds.list` label:procedure[Procedure] +| xref:installation/installation.adoc#_verifying_the_installation[List all operations in GDS] | `gds.list` label:procedure[Procedure] | xref:common-usage/logging.adoc#logging-progress-logging[List logged progress] | `gds.listProgress` label:procedure[Procedure] | xref:common-usage/logging.adoc#logging-user-warnings[List warnings] | `gds.userLog` label:procedure[Procedure] -.2+<.^| xref:installation/index.adoc#_verifying_the_installation[The license state of the installed GDS] | `gds.license.state` label:procedure[Procedure] +.2+<.^| xref:installation/installation.adoc#_verifying_the_installation[The license state of the installed GDS] | `gds.license.state` label:procedure[Procedure] | `gds.isLicensed` label:function[Function] .2+<.^| xref:management-ops/utility-functions.adoc#utility-functions-node-path[Node id functions] | `gds.util.asNode` label:function[Function] diff --git a/doc/modules/ROOT/pages/production-deployment/composite.adoc b/doc/modules/ROOT/pages/production-deployment/composite.adoc index 4b934b292e..1f1e35fd7d 100644 --- a/doc/modules/ROOT/pages/production-deployment/composite.adoc +++ b/doc/modules/ROOT/pages/production-deployment/composite.adoc @@ -48,7 +48,7 @@ Another use case is to replicate the graph's topology across multiple shards, wh In this scenario we need to set up the shards to run the Neo4j Graph Data Science library. -Every shard that will run the Graph Data Science library should be configured just as a standalone GDS database would be, for more information see xref:installation/index.adoc[Installation]. +Every shard that will run the Graph Data Science library should be configured just as a standalone GDS database would be, for more information see xref:installation/installation.adoc[Installation]. The composite database does not require any special configuration, i.e., the GDS library plugin does not need to be installed. However, the Composite database should be configured to handle the amount of data received from the shards. @@ -118,7 +118,7 @@ CAUTION: Procedure `write` modes are not supported when GDS is hosted on a compo In this scenario we need to set up the proxy to run the Neo4j Graph Data Science library. The dbms that manages the composite database needs to have the GDS plugin installed and configured. -For more information see xref:installation/index.adoc[Installation]. +For more information see xref:installation/installation.adoc[Installation]. The proxy node should also be configured to handle the amount of data received from the shards as well as executing graph projections and algorithms. Fabric shards do not need any special configuration, i.e., the GDS library plugin does not need to be installed.