fix update mkdocs

Signed-off-by: Jan Jansen <[email protected]>
JanusGraph · Nov 12, 2023 · 488cac3 · 488cac3
1 parent ba4b083
commit 488cac3
Show file tree

Hide file tree

Showing 8 changed files with 183 additions and 147 deletions.
diff --git a/docs.Dockerfile b/docs.Dockerfile
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM python:3.8
+FROM python:3.12
 
 ENV PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/root/.local/bin
 

diff --git a/docs/advanced-topics/commit-releases.md b/docs/advanced-topics/commit-releases.md
@@ -19,17 +19,19 @@ under the same group id `org.janusgraph`, but with different artifact id format.
 Official JanusGraph releases have the next format for artifact id: `MAJOR.MINOR.PATCH`.  
 Dependencies example:
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.2</version>
-</dependency>
-```
-
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.2"
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>1.0.0</version>
+    </dependency>
+    ```
+
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:1.0.0"
+    ```
 
 Artifact id for commit releases have the next format: `FOLLOWING_VERSION-DATE-TIME.COMMIT`.  
 
@@ -41,17 +43,19 @@ It has `MAJOR.MINOR.PATCH` format.
 
 Dependencies example:
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.3-20230104-164606.a49366e</version>
-</dependency>
-```
-
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.3-20230104-164606.a49366e"
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>0.6.3-20230104-164606.a49366e</version>
+    </dependency>
+    ```
+
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:0.6.3-20230104-164606.a49366e"
+    ```
 
 ## JanusGraph distribution builds
 

diff --git a/docs/advanced-topics/hadoop.md b/docs/advanced-topics/hadoop.md
@@ -34,7 +34,7 @@ computations of various OLAP queries may be persisted on the Hadoop file
 system.
 
 For configuring a single node Hadoop cluster, please refer to official
-[Apache Hadoop Docs](https://hadoop.apache.org/docs/r{{hadoop_version }}/hadoop-project-dist/hadoop-common/SingleCluster.html)
+[Apache Hadoop Docs](https://hadoop.apache.org/docs/r{{ hadoop_version }}/hadoop-project-dist/hadoop-common/SingleCluster.html)
 
 Once you have a Hadoop cluster up and running, we will need to specify
 the Hadoop configuration files in the `CLASSPATH`. The below document
@@ -83,13 +83,21 @@ JanusGraph directly supports following graphReader classes:
 The following `.properties` files can be used to connect a JanusGraph
 instance such that it can be used with HadoopGraph to run OLAP queries.
 
-```properties tab='read-cql.properties'
-{!../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-cql.properties!}
-```
+=== "read-cql.properties"
 
-```properties tab='read-hbase.properties'
-{!../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-hbase.properties!}
-```
+    ```properties
+    {%
+        include "../../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-cql.properties"
+    %}
+    ```
+
+=== "read-hbase.properties"
+
+    ```properties
+    {%
+        include "../../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-hbase.properties"
+    %}
+    ```
 
 First create a properties file with above configurations, and load the
 same on the Gremlin Console to run OLAP queries as follows:
@@ -169,13 +177,21 @@ standalone cluster with only minor changes:
 
 The final properties file used for OLAP traversal is as follows:
 
-```properties tab='read-cql-standalone-cluster.properties'
-{!../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-cql-standalone-cluster.properties!}
-```
+=== "read-cql-standalone-cluster.properties"
 
-```properties tab='read-hbase-standalone-cluster.properties'
-{!../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-hbase-standalone-cluster.properties!}
-```
+    ```properties
+    {%
+        include "../../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-cql-standalone-cluster.properties"
+    %}
+    ```
+
+=== "read-hbase-standalone-cluster.properties"
+
+    ```properties
+    {%
+        include "../../janusgraph-dist/src/assembly/static/conf/hadoop-graph/read-hbase-standalone-cluster.properties"
+    %}
+    ```
 
 Then use the properties file as follows from the Gremlin Console:
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -51,17 +51,19 @@ The versions of JanusGraph listed below are outdated and will no longer receive
 
 ### Version 1.0.0 (Release Date: October 21, 2023)
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>1.0.0</version>
-</dependency>
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>1.0.0</version>
+    </dependency>
+    ```
 
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:1.0.0"
-```
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:1.0.0"
+    ```
 
 **Tested Compatibility:**
 
@@ -410,17 +412,19 @@ See additional properties to control grouping configurations under the namespace
 
 ### Version 0.6.4 (Release Date: October 14, 2023)
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.4</version>
-</dependency>
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>0.6.4</version>
+    </dependency>
+    ```
 
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.4"
-```
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:0.6.4"
+    ```
 
 **Tested Compatibility:**
 
@@ -464,17 +468,19 @@ JanusGraph 1.0.0 uses Log4j2 by default.
 
 ### Version 0.6.3 (Release Date: February 18, 2023)
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.3</version>
-</dependency>
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>0.6.3</version>
+    </dependency>
+    ```
 
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.3"
-```
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:0.6.3"
+    ```
 
 **Tested Compatibility:**
 
@@ -512,17 +518,19 @@ For more information on features and bug fixes in 0.6.3, see the GitHub mileston
 
 ### Version 0.6.2 (Release Date: May 31, 2022)
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.2</version>
-</dependency>
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>0.6.2</version>
+    </dependency>
+    ```
 
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.2"
-```
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:0.6.2"
+    ```
 
 **Tested Compatibility:**
 
@@ -551,17 +559,19 @@ For more information on features and bug fixes in 0.6.2, see the GitHub mileston
 
 ### Version 0.6.1 (Release Date: January 18, 2022)
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.1</version>
-</dependency>
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>0.6.1</version>
+    </dependency>
+    ```
 
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.1"
-```
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:0.6.1"
+    ```
 
 **Tested Compatibility:**
 
@@ -617,17 +627,19 @@ setting again or change it to the TinkerPop `GraphManager` that has been the def
 
 ### Version 0.6.0 (Release Date: September 3, 2021)
 
-```xml tab='Maven'
-<dependency>
-    <groupId>org.janusgraph</groupId>
-    <artifactId>janusgraph-core</artifactId>
-    <version>0.6.0</version>
-</dependency>
-```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.janusgraph</groupId>
+        <artifactId>janusgraph-core</artifactId>
+        <version>0.6.0</version>
+    </dependency>
+    ```
 
-```groovy tab='Gradle'
-compile "org.janusgraph:janusgraph-core:0.6.0"
-```
+=== "Gradle"
+    ```groovy
+    compile "org.janusgraph:janusgraph-core:0.6.0"
+    ```
 
 **Tested Compatibility:**
 

diff --git a/docs/configs/configuration-reference.md b/docs/configs/configuration-reference.md
@@ -60,4 +60,6 @@ log.user.send-batch-size = 100
 ```
 
 ## Configuration Namespaces and Options
-{!configs/janusgraph-cfg.md!}
+{%
+    include "configs/janusgraph-cfg.md"
+%}