Skip to content

Commit

Permalink
fix update mkdocs
Browse files Browse the repository at this point in the history 
Signed-off-by: Jan Jansen <[email protected]>
  • Loading branch information
@farodin91
farodin91 committed Nov 12, 2023
1 parent ba4b083 commit 8892c31
Show file tree
Hide file tree
Showing 9 changed files with 205 additions and 168 deletions.
2 changes: 1 addition & 1 deletion docs.Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
48 changes: 26 additions & 22 deletions docs/advanced-topics/commit-releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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

Expand Down
42 changes: 29 additions & 13 deletions docs/advanced-topics/hadoop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:

Expand Down
132 changes: 72 additions & 60 deletions docs/changelog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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:**

Expand Down
4 changes: 3 additions & 1 deletion docs/configs/configuration-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,6 @@ log.user.send-batch-size = 100
```

## Configuration Namespaces and Options
{!configs/janusgraph-cfg.md!}
{%
include "configs/janusgraph-cfg.md"
%}
40 changes: 21 additions & 19 deletions docs/getting-started/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,27 @@ $ docker run --name janusgraph-default janusgraph/janusgraph:latest
The above command launches a JanusGraph Server instance. We name the container so that we can link a second container to it.
The server may need a few seconds to start up so be patient and wait for the corresponding log messages to appear.

??? note "Example log"
```
SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/opt/janusgraph/lib/slf4j-log4j12-1.7.12.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/opt/janusgraph/lib/logback-classic-1.1.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [org.slf4j.impl.Log4jLoggerFactory]
0 [main] INFO com.jcabi.manifests.Manifests - 110 attributes loaded from 283 stream(s) in 130ms, 110 saved, 3770 ignored: ["Agent-Class", "Ant-Version", "Archiver-Version", "Automatic-Module-Name", "Bnd-LastModified", "Boot-Class-Path", "Branch", "Build-Date", "Build-Host", "Build-Id", "Build-Java-Version", "Build-Jdk", "Build-Job", "Build-Number", "Build-Timestamp", "Build-Version", "Built-At", "Built-By", "Built-Date", "Built-OS", "Built-On", "Built-Status", "Bundle-ActivationPolicy", "Bundle-Activator", "Bundle-BuddyPolicy", "Bundle-Category", "Bundle-ClassPath", "Bundle-ContactAddress", "Bundle-Description", "Bundle-DocURL", "Bundle-License", "Bundle-ManifestVersion", "Bundle-Name", "Bundle-NativeCode", "Bundle-RequiredExecutionEnvironment", "Bundle-SymbolicName", "Bundle-Vendor", "Bundle-Version", "Can-Redefine-Classes", "Change", "Class-Path", "Created-By", "DSTAMP", "DynamicImport-Package", "Eclipse-BuddyPolicy", "Eclipse-ExtensibleAPI", "Embed-Dependency", "Embed-Transitive", "Export-Package", "Extension-Name", "Extension-name", "Fragment-Host", "Gradle-Version", "Gremlin-Lib-Paths", "Gremlin-Plugin-Dependencies", "Gremlin-Plugin-Paths", "Ignore-Package", "Implementation-Build", "Implementation-Build-Date", "Implementation-Title", "Implementation-URL", "Implementation-Vendor", "Implementation-Vendor-Id", "Implementation-Version", "Import-Package", "Include-Resource", "JCabi-Build", "JCabi-Date", "JCabi-Version", "Java-Vendor", "Java-Version", "Main-Class", "Manifest-Version", "Maven-Version", "Module-Email", "Module-Origin", "Module-Owner", "Module-Source", "Originally-Created-By", "Os-Arch", "Os-Name", "Os-Version", "Package", "Premain-Class", "Private-Package", "Provide-Capability", "Require-Bundle", "Require-Capability", "Scm-Connection", "Scm-Revision", "Scm-Url", "Specification-Title", "Specification-Vendor", "Specification-Version", "TODAY", "TSTAMP", "Time-Zone-Database-Version", "Tool", "X-Compile-Elasticsearch-Snapshot", "X-Compile-Elasticsearch-Version", "X-Compile-Lucene-Version", "X-Compile-Source-JDK", "X-Compile-Target-JDK", "hash", "implementation-version", "mode", "package", "service", "url", "version"]
1 [main] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - 3.4.1
\,,,/
(o o)
-----oOOo-(3)-oOOo-----

100 [main] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - Configuring Gremlin Server from /etc/opt/janusgraph/gremlin-server.yaml
...
...
3965 [gremlin-server-boss-1] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - Gremlin Server configured with worker thread pool of 1, gremlin pool of 8 and boss thread pool of 1.
3965 [gremlin-server-boss-1] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - Channel started at port 8182.
```
/// details | Example log
type: note
```
SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/opt/janusgraph/lib/slf4j-log4j12-1.7.12.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/opt/janusgraph/lib/logback-classic-1.1.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [org.slf4j.impl.Log4jLoggerFactory]
0 [main] INFO com.jcabi.manifests.Manifests - 110 attributes loaded from 283 stream(s) in 130ms, 110 saved, 3770 ignored: ["Agent-Class", "Ant-Version", "Archiver-Version", "Automatic-Module-Name", "Bnd-LastModified", "Boot-Class-Path", "Branch", "Build-Date", "Build-Host", "Build-Id", "Build-Java-Version", "Build-Jdk", "Build-Job", "Build-Number", "Build-Timestamp", "Build-Version", "Built-At", "Built-By", "Built-Date", "Built-OS", "Built-On", "Built-Status", "Bundle-ActivationPolicy", "Bundle-Activator", "Bundle-BuddyPolicy", "Bundle-Category", "Bundle-ClassPath", "Bundle-ContactAddress", "Bundle-Description", "Bundle-DocURL", "Bundle-License", "Bundle-ManifestVersion", "Bundle-Name", "Bundle-NativeCode", "Bundle-RequiredExecutionEnvironment", "Bundle-SymbolicName", "Bundle-Vendor", "Bundle-Version", "Can-Redefine-Classes", "Change", "Class-Path", "Created-By", "DSTAMP", "DynamicImport-Package", "Eclipse-BuddyPolicy", "Eclipse-ExtensibleAPI", "Embed-Dependency", "Embed-Transitive", "Export-Package", "Extension-Name", "Extension-name", "Fragment-Host", "Gradle-Version", "Gremlin-Lib-Paths", "Gremlin-Plugin-Dependencies", "Gremlin-Plugin-Paths", "Ignore-Package", "Implementation-Build", "Implementation-Build-Date", "Implementation-Title", "Implementation-URL", "Implementation-Vendor", "Implementation-Vendor-Id", "Implementation-Version", "Import-Package", "Include-Resource", "JCabi-Build", "JCabi-Date", "JCabi-Version", "Java-Vendor", "Java-Version", "Main-Class", "Manifest-Version", "Maven-Version", "Module-Email", "Module-Origin", "Module-Owner", "Module-Source", "Originally-Created-By", "Os-Arch", "Os-Name", "Os-Version", "Package", "Premain-Class", "Private-Package", "Provide-Capability", "Require-Bundle", "Require-Capability", "Scm-Connection", "Scm-Revision", "Scm-Url", "Specification-Title", "Specification-Vendor", "Specification-Version", "TODAY", "TSTAMP", "Time-Zone-Database-Version", "Tool", "X-Compile-Elasticsearch-Snapshot", "X-Compile-Elasticsearch-Version", "X-Compile-Lucene-Version", "X-Compile-Source-JDK", "X-Compile-Target-JDK", "hash", "implementation-version", "mode", "package", "service", "url", "version"]
1 [main] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - 3.4.1
\,,,/
(o o)
-----oOOo-(3)-oOOo-----
100 [main] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - Configuring Gremlin Server from /etc/opt/janusgraph/gremlin-server.yaml
...
...
3965 [gremlin-server-boss-1] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - Gremlin Server configured with worker thread pool of 1, gremlin pool of 8 and boss thread pool of 1.
3965 [gremlin-server-boss-1] INFO org.apache.tinkerpop.gremlin.server.GremlinServer - Channel started at port 8182.
```
///

We can now instruct Docker to start a second container for the client and link it to the already running server. Here we
use Gremlin Console (`gremlin.sh`) as the client.
Expand Down
Loading

0 comments on commit 8892c31

Please sign in to comment.