From e8f4e71a9d9f1ecd1ebfb2c2ce5c189d9759a723 Mon Sep 17 00:00:00 2001 From: lidiazuin Date: Mon, 10 Jun 2024 11:32:06 +0200 Subject: [PATCH] Replacing underscores with hyphens for crawlability --- modules/ROOT/content-nav.adoc | 6 +++--- modules/ROOT/images/README.md | 16 ++++++++-------- .../{jconsole_beans.png => jconsole-beans.png} | Bin ...{jconsole_beans1.png => jconsole-beans1.png} | Bin ...console_connect.png => jconsole-connect.png} | Bin ...nsole_connect1.png => jconsole-connect1.png} | Bin ...mple.svg => traversal-framework-example.svg} | 0 ...ph.png => traversal-order-example-graph.png} | Bin modules/ROOT/pages/jmx-metrics.adoc | 4 ++-- ...c => bidirectional-traversal-framework.adoc} | 2 +- .../ROOT/pages/traversal-framework/index.adoc | 8 ++++---- ...le.adoc => traversal-framework-example.adoc} | 4 ++-- ...i.adoc => traversal-framework-java-api.adoc} | 2 +- 13 files changed, 21 insertions(+), 21 deletions(-) rename modules/ROOT/images/{jconsole_beans.png => jconsole-beans.png} (100%) rename modules/ROOT/images/{jconsole_beans1.png => jconsole-beans1.png} (100%) rename modules/ROOT/images/{jconsole_connect.png => jconsole-connect.png} (100%) rename modules/ROOT/images/{jconsole_connect1.png => jconsole-connect1.png} (100%) rename modules/ROOT/images/{traversal_framework_example.svg => traversal-framework-example.svg} (100%) rename modules/ROOT/images/{traversal_order_example_graph.png => traversal-order-example-graph.png} (100%) rename modules/ROOT/pages/traversal-framework/{bidirectional_traversal_framework.adoc => bidirectional-traversal-framework.adoc} (99%) rename modules/ROOT/pages/traversal-framework/{traversal_framework_example.adoc => traversal-framework-example.adoc} (97%) rename modules/ROOT/pages/traversal-framework/{traversal_framework_java_api.adoc => traversal-framework-java-api.adoc} (99%) diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index c87629d..16c8b51 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -30,9 +30,9 @@ ** xref:java-embedded/query-parameters.adoc[] * xref:traversal-framework/index.adoc[] -** xref:traversal-framework/traversal_framework_java_api.adoc[] -** xref:traversal-framework/bidirectional_traversal_framework.adoc[] -** xref:traversal-framework/traversal_framework_example.adoc[] +** xref:traversal-framework/traversal-framework-java-api.adoc[] +** xref:traversal-framework/bidirectional-traversal-framework.adoc[] +** xref:traversal-framework/traversal-framework-example.adoc[] * xref:transaction-management.adoc[] diff --git a/modules/ROOT/images/README.md b/modules/ROOT/images/README.md index 3026dd5..14cffc8 100644 --- a/modules/ROOT/images/README.md +++ b/modules/ROOT/images/README.md @@ -25,24 +25,24 @@ Images. ![](hello-world.png) -`jconsole_beans.png` +`jconsole-beans.png` -![](jconsole_beans.png) +![](jconsole-beans.png) -`jconsole_beans1.png` +`jconsole-beans1.png` -![](jconsole_beans.png) +![](jconsole-beans.png) -`jconsole_connect.png` +`jconsole-connect.png` -![](jconsole_beans.png) +![](jconsole-beans.png) -`jconsole_connect1.png` +`jconsole-connect1.png` -![](jconsole_connect1.png) +![](jconsole-connect1.png) `play.png` diff --git a/modules/ROOT/images/jconsole_beans.png b/modules/ROOT/images/jconsole-beans.png similarity index 100% rename from modules/ROOT/images/jconsole_beans.png rename to modules/ROOT/images/jconsole-beans.png diff --git a/modules/ROOT/images/jconsole_beans1.png b/modules/ROOT/images/jconsole-beans1.png similarity index 100% rename from modules/ROOT/images/jconsole_beans1.png rename to modules/ROOT/images/jconsole-beans1.png diff --git a/modules/ROOT/images/jconsole_connect.png b/modules/ROOT/images/jconsole-connect.png similarity index 100% rename from modules/ROOT/images/jconsole_connect.png rename to modules/ROOT/images/jconsole-connect.png diff --git a/modules/ROOT/images/jconsole_connect1.png b/modules/ROOT/images/jconsole-connect1.png similarity index 100% rename from modules/ROOT/images/jconsole_connect1.png rename to modules/ROOT/images/jconsole-connect1.png diff --git a/modules/ROOT/images/traversal_framework_example.svg b/modules/ROOT/images/traversal-framework-example.svg similarity index 100% rename from modules/ROOT/images/traversal_framework_example.svg rename to modules/ROOT/images/traversal-framework-example.svg diff --git a/modules/ROOT/images/traversal_order_example_graph.png b/modules/ROOT/images/traversal-order-example-graph.png similarity index 100% rename from modules/ROOT/images/traversal_order_example_graph.png rename to modules/ROOT/images/traversal-order-example-graph.png diff --git a/modules/ROOT/pages/jmx-metrics.adoc b/modules/ROOT/pages/jmx-metrics.adoc index e9b2c07..fd877d8 100644 --- a/modules/ROOT/pages/jmx-metrics.adoc +++ b/modules/ROOT/pages/jmx-metrics.adoc @@ -172,7 +172,7 @@ $JAVA_HOME/bin/jconsole Connect to the process running your Neo4j database instance: .Connecting JConsole to the Neo4j Java process -image::jconsole_connect1.png[alt="Connecting with JConsole", width=300] +image::jconsole-connect1.png[alt="Connecting with JConsole", width=300] [NOTE] ==== @@ -187,5 +187,5 @@ Under that, you have access to all the monitoring information exposed by Neo4j. For opening JMX to remote monitoring access, please see <> and link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html#GUID-805517EC-2D33-4D61-81D8-4D0FA770D1B8[the JMX documention^]. .Neo4j MBeans view -image::jconsole_beans1.png[alt="Neo4j MBeans view", width=600] +image::jconsole-beans1.png[alt="Neo4j MBeans view", width=600] diff --git a/modules/ROOT/pages/traversal-framework/bidirectional_traversal_framework.adoc b/modules/ROOT/pages/traversal-framework/bidirectional-traversal-framework.adoc similarity index 99% rename from modules/ROOT/pages/traversal-framework/bidirectional_traversal_framework.adoc rename to modules/ROOT/pages/traversal-framework/bidirectional-traversal-framework.adoc index e656923..ac6df24 100644 --- a/modules/ROOT/pages/traversal-framework/bidirectional_traversal_framework.adoc +++ b/modules/ROOT/pages/traversal-framework/bidirectional-traversal-framework.adoc @@ -22,7 +22,7 @@ In the accepted path `(1)-[:A]->(2)-[:A]->(3)-[:B]->(4)-[:B]->(5)`, the traverse ==== The `Uniqueness` is shared between both traversals, which means that there will be no results if the `Uniqueness` is set to `Uniqueness.NODE_GLOBAL` (which is the default) as both traversals need to reach the same node to cause a collision. Therefore, when using `BidirectionalTraversalDescription`, always set the `Uniqueness` manually. -For more information on the available options, see xref:traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-uniqueness[`Uniqueness` options]. +For more information on the available options, see xref:traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-uniqueness[`Uniqueness` options]. ==== == Defining the bidirectional traverser diff --git a/modules/ROOT/pages/traversal-framework/index.adoc b/modules/ROOT/pages/traversal-framework/index.adoc index 7e00dc1..50e6810 100644 --- a/modules/ROOT/pages/traversal-framework/index.adoc +++ b/modules/ROOT/pages/traversal-framework/index.adoc @@ -29,7 +29,7 @@ image::graphdb-traversal-description.svg[role="middle"] The Traversal Framework can be used xref:java-embedded/traversal.adoc[embedded in Java applications]. It can also be used when extending Neo4j with a xref:/extending-neo4j/procedures.adoc[User-defined Procedure]. -For an example, see xref:traversal-framework/traversal_framework_example.adoc#traversal-in-a-procedure-example[User-defined procedure with a Traversal Framework]. +For an example, see xref:traversal-framework/traversal-framework-example.adoc#traversal-in-a-procedure-example[User-defined procedure with a Traversal Framework]. [[traversal-vs-cypher]] == Traversal Framework vs Cypher @@ -41,11 +41,11 @@ Some of the advantages of using the Traversal Framework over Cypher include: * The Traversal Framework allows the use of any desired Java library to help in the evaluation of the traversal. * It allows customized pruning during the traversal of a path, which could potentially improve the performance of a traversal. -See xref:/traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-evaluator[Evaluator] for more information. +See xref:/traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-evaluator[Evaluator] for more information. * With Cypher, it is not possible to specify the order in which paths are expanded (e.g. depth-first). -However, with the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-branchselector[order of paths traversed]. +However, with the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-branchselector[order of paths traversed]. * With Cypher, relationships are only traversed when `RELATIONSHIP_GLOBAL` uniqueness is specified. -By using the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-uniqueness[uniqueness constraints on the path traversed]. +By using the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-uniqueness[uniqueness constraints on the path traversed]. [WARNING] ==== diff --git a/modules/ROOT/pages/traversal-framework/traversal_framework_example.adoc b/modules/ROOT/pages/traversal-framework/traversal-framework-example.adoc similarity index 97% rename from modules/ROOT/pages/traversal-framework/traversal_framework_example.adoc rename to modules/ROOT/pages/traversal-framework/traversal-framework-example.adoc index 2d452af..d5b1355 100644 --- a/modules/ROOT/pages/traversal-framework/traversal_framework_example.adoc +++ b/modules/ROOT/pages/traversal-framework/traversal-framework-example.adoc @@ -8,7 +8,7 @@ The following are some examples of how you can use the Traversal Framework. The source code for the examples can be found in link:https://github.com/neo4j/neo4j-documentation/blob/dev/embedded-examples/src/main/java/org/neo4j/examples/TraversalExample.java[`TraversalExample.java`^]. -image::traversal_framework_example.svg[role="middle"] +image::traversal-framework-example.svg[role="middle"] This graph illustrates a small group of friends with the definition of `RelationshipType`: @@ -119,7 +119,7 @@ This gives the following output: (0)-[KNOWS,0]->(2)<-[KNOWS,2]-(3)<-[KNOWS,3]-(4)<-[KNOWS,4]-(1) ---- -For other useful evaluators, see xref:traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-evaluator[Using Evaluators]. +For other useful evaluators, see xref:traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-evaluator[Using Evaluators]. The `Traverser` also has a `nodes()` method, which returns an `Iterable` of all the nodes in the paths: diff --git a/modules/ROOT/pages/traversal-framework/traversal_framework_java_api.adoc b/modules/ROOT/pages/traversal-framework/traversal-framework-java-api.adoc similarity index 99% rename from modules/ROOT/pages/traversal-framework/traversal_framework_java_api.adoc rename to modules/ROOT/pages/traversal-framework/traversal-framework-java-api.adoc index a60c2f1..45d51b9 100644 --- a/modules/ROOT/pages/traversal-framework/traversal_framework_java_api.adoc +++ b/modules/ROOT/pages/traversal-framework/traversal-framework-java-api.adoc @@ -230,7 +230,7 @@ Keep in mind that breadth-first traversals have a higher memory overhead than de The following example shows the result of `BranchOrderingPolicy` without any extra filter: -image::traversal_order_example_graph.png[align="center", role="middle", width=200] +image::traversal-order-example-graph.png[align="center", role="middle", width=200] [cols="1,1"] |===