[Doc] Rename 'Interactions with JanusGraph' section to 'JanusGraph Ba…

…sics' The JanusGraph Basics section was split into a few sections in v0.6, one of which was 'Interactions with JanusGraph'. This section contains 3 things: transactions, predicates, and drivers. It's hard to find a common topic among them, and 'interactions' is a very vague word that is not straight-forward to understand. This renames the section back to 'JanusGraph Basics', because transactions, predicates, and drivers are the necessary basic staff one has to learn about in order to use JanusGraph. Signed-off-by: Boxuan Li <[email protected]>
JanusGraph · Oct 5, 2023 · 64b06f7 · 64b06f7
1 parent f23abbe
commit 64b06f7
Show file tree

Hide file tree

Showing 16 changed files with 28 additions and 23 deletions.
diff --git a/docs/advanced-topics/eventual-consistency.md b/docs/advanced-topics/eventual-consistency.md
@@ -175,7 +175,7 @@ The following strategies can be used to mitigate this issue:
 
 **Existence checks**  
 Configure transactions to (double) check for the existence of vertices
-prior to returning them. Please see [Transaction Configuration](../interactions/transactions.md#transaction-configuration) for more
+prior to returning them. Please see [Transaction Configuration](../basics/transactions.md#transaction-configuration) for more
 information and note that this can significantly decrease performance.
 Note, that this does not fix the inconsistencies but hides some of them
 from the user.

diff --git a/docs/advanced-topics/technical-limitations.md b/docs/advanced-topics/technical-limitations.md
@@ -80,7 +80,7 @@ JanusGraph.
 ### Limited Mixed Index Support
 
 Mixed indexes only support a subset of the data types that JanusGraph
-supports. See [Mixed Index Data Types](../interactions/search-predicates.md#data-type-support) for a current
+supports. See [Mixed Index Data Types](../basics/search-predicates.md#data-type-support) for a current
 listing. Also, mixed indexes do not currently support property keys with
 SET or LIST cardinality.
 

diff --git a/docs/interactions/connecting/dotnet.md → docs/basics/connecting/dotnet.md b/docs/interactions/connecting/dotnet.md → docs/basics/connecting/dotnet.md
diff --git a/docs/interactions/connecting/index.md → docs/basics/connecting/index.md b/docs/interactions/connecting/index.md → docs/basics/connecting/index.md
diff --git a/docs/interactions/connecting/java.md → docs/basics/connecting/java.md b/docs/interactions/connecting/java.md → docs/basics/connecting/java.md
diff --git a/docs/interactions/connecting/python.md → docs/basics/connecting/python.md b/docs/interactions/connecting/python.md → docs/basics/connecting/python.md
diff --git a/docs/interactions/search-predicates.md → docs/basics/search-predicates.md b/docs/interactions/search-predicates.md → docs/basics/search-predicates.md
diff --git a/docs/interactions/transactions.md → docs/basics/transactions.md b/docs/interactions/transactions.md → docs/basics/transactions.md
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -750,7 +750,7 @@ after the keyword `serializers`. This will add the support on the server site.
 ```
 !!! note 
     The java driver is the only driver that currently supports GraphBinary, 
-    see [Connecting to JanusGraph using Java](interactions/connecting/java.md).
+    see [Connecting to JanusGraph using Java](basics/connecting/java.md).
 
 !!! note
     Version 1.0.0 moves everything under `org.apache.tinkerpop.gremlin.driver.ser` package to

diff --git a/docs/common-questions.md b/docs/common-questions.md
@@ -54,7 +54,7 @@ is to allow ghost vertices temporarily and clearing them out in regular
 time intervals.
 
 Another option is to detect them at read-time using the option
-`checkInternalVertexExistence()` documented in [Transaction Configuration](interactions/transactions.md#transaction-configuration).
+`checkInternalVertexExistence()` documented in [Transaction Configuration](basics/transactions.md#transaction-configuration).
 
 ## Debug-level Logging Slows Execution
 

diff --git a/docs/getting-started/gremlin.md b/docs/getting-started/gremlin.md
@@ -39,7 +39,7 @@ information on Gremlin, refer to the following resources:
 - [Gremlin for SQL developers](http://sql2gremlin.com): Learn Gremlin
     using typical patterns found when querying data with SQL.
 
-In addition to these resources, [Connecting to JanusGraph](../interactions/connecting/index.md) explains how Gremlin
+In addition to these resources, [Connecting to JanusGraph](../basics/connecting/index.md) explains how Gremlin
 can be used in different programming languages to query a JanusGraph
 Server.
 
@@ -163,7 +163,7 @@ traversal above is correct.
 !!! note
     The Gremlin overview presented in this section focused on the
     Gremlin-Groovy language implementation used in the Gremlin Console.
-    Refer to [Connecting to JanusGraph](../interactions/connecting/index.md) for information about connecting to
+    Refer to [Connecting to JanusGraph](../basics/connecting/index.md) for information about connecting to
     JanusGraph with other languages than Groovy and independent of the
     Gremlin Console.
 

diff --git a/docs/operations/configured-graph-factory.md b/docs/operations/configured-graph-factory.md
@@ -453,7 +453,7 @@ It is recommended to use a sessioned connection when creating a
 Configured Graph Factory template. If a sessioned connection is not used
 the Configured Graph Factory Template creation must be sent to the
 server as a single line using semi-colons. See details on sessions can
-be found in [Connecting to Gremlin Server](../interactions/connecting/index.md).
+be found in [Connecting to Gremlin Server](../basics/connecting/index.md).
 
 ```groovy
 gremlin> :remote connect tinkerpop.server conf/remote.yaml session

diff --git a/docs/operations/container.md b/docs/operations/container.md
@@ -69,7 +69,7 @@ When the container is started it will execute files with the extension
 Gremlin Console.
 These scripts are only executed after the JanusGraph Server instance was
 started.
-So, they can [connect to it](../interactions/connecting/index.md) and execute Gremlin traversals.
+So, they can [connect to it](../basics/connecting/index.md) and execute Gremlin traversals.
 
 For example, to add a vertex to the graph, create a file
 `/docker-entrypoint-initdb.d/add-vertex.groovy` with the following content:

diff --git a/docs/operations/server.md b/docs/operations/server.md
@@ -9,7 +9,7 @@ against one or more JanusGraph instances hosted within it. This section
 will describe how to use the WebSocket configuration, as well as
 describe how to configure JanusGraph Server to handle HTTP endpoint
 interactions. For information about how to connect to a JanusGraph
-Server from different languages refer to [Connecting to JanusGraph](../interactions/connecting/index.md).
+Server from different languages refer to [Connecting to JanusGraph](../basics/connecting/index.md).
 
 ## Starting a JanusGraph Server
 

diff --git a/docs/schema/index-management/index-performance.md b/docs/schema/index-management/index-performance.md
@@ -218,7 +218,7 @@ g.V().or(__.has('name', textContains('hercules')), __.has('age', inside(20, 50))
 ```
 
 Mixed indexes support full-text search, range search, geo search and
-others. Refer to [Search Predicates and Data Types](../../interactions/search-predicates.md) for a list of predicates
+others. Refer to [Search Predicates and Data Types](../../basics/search-predicates.md) for a list of predicates
 supported by a particular indexing backend.
 
 !!! note

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,18 +36,23 @@ plugins:
         basics/deployment.md: operations/deployment.md
         basics/configured-graph-factory.md: operations/configured-graph-factory.md
         basics/multi-node.md: operations/dynamic-graphs.md
-        basics/transactions.md: interactions/transactions.md
+        interactions/transactions.md: basics/transactions.md
         basics/configuration-reference.md: configs/configuration-reference.md
         basics/example-config.md: configs/example-config.md
         index-management/index-performance.md: schema/index-management/index-performance.md
         index-management/index-lifecycle.md: schema/index-management/index-lifecycle.md
         index-management/index-reindexing.md: schema/index-management/index-reindexing.md
         index-management/index-removal.md: schema/index-management/index-removal.md
-        index-backend/search-predicates.md: interactions/search-predicates.md
-        connecting/index.md: interactions/connecting/index.md
-        connecting/java.md: interactions/connecting/java.md
-        connecting/python.md: interactions/connecting/python.md
-        connecting/dotnet.md: interactions/connecting/dotnet.md
+        index-backend/search-predicates.md: basics/search-predicates.md
+        connecting/index.md: basics/connecting/index.md
+        connecting/java.md: basics/connecting/java.md
+        connecting/python.md: basics/connecting/python.md
+        connecting/dotnet.md: basics/connecting/dotnet.md
+        interactions/search-predicates.md: basics/search-predicates.md
+        interactions/connecting/index.md: basics/connecting/index.md
+        interactions/connecting/java.md: basics/connecting/java.md
+        interactions/connecting/python.md: basics/connecting/python.md
+        interactions/connecting/dotnet.md: basics/connecting/dotnet.md
         advanced-topics/bulk-loading.md: operations/bulk-loading.md
         advanced-topics/advschema.md: schema/advschema.md
         advanced-topics/monitoring.md: operations/monitoring.md
@@ -104,14 +109,14 @@ nav:
     - Basic Usage: getting-started/basic-usage.md
     - Gremlin Query Language: getting-started/gremlin.md
     - Architectural Overview: getting-started/architecture.md
-  - Interactions with JanusGraph:
-    - Transactions: interactions/transactions.md
-    - Search Predicates and Mixed Index Data Types: interactions/search-predicates.md
+  - JanusGraph Basics:
+    - Transactions: basics/transactions.md
+    - Search Predicates and Mixed Index Data Types: basics/search-predicates.md
     - Connecting to JanusGraph:
-      - Introduction: interactions/connecting/index.md
-      - Using Java: interactions/connecting/java.md
-      - Using Python: interactions/connecting/python.md
-      - Using .NET: interactions/connecting/dotnet.md
+      - Introduction: basics/connecting/index.md
+      - Using Java: basics/connecting/java.md
+      - Using Python: basics/connecting/python.md
+      - Using .NET: basics/connecting/dotnet.md
   - Configuration:
     - Introduction: configs/index.md
     - Configuration Reference: configs/configuration-reference.md