This is an automated email from the ASF dual-hosted git repository. spmallette pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit de039c5db2b85ca213d3222b0ce5bf8e7191d0e9 Author: Stephen Mallette <[email protected]> AuthorDate: Wed Jul 15 12:16:24 2026 -0400 Move tinkerpop-docs from tools/ to docs/ Relocate the docs build tooling under docs/ and update the path references in process-docs.sh, .gitignore, and the developer guide. Assisted-by: Claude Code:claude-opus-4-8 --- .gitignore | 2 -- bin/process-docs.sh | 2 +- docs/src/dev/developer/development-environment.asciidoc | 2 +- {tools => docs}/tinkerpop-docs/pom.xml | 0 .../java/org/apache/tinkerpop/gremlin/docs/ConsoleRestartHandler.java | 0 .../src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinConsole.java | 0 .../java/org/apache/tinkerpop/gremlin/docs/GremlinDocsExtension.java | 0 .../java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessor.java | 0 .../apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandler.java | 0 .../main/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilder.java | 0 .../services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry | 0 .../tinkerpop-docs/src/main/resources/hadoop-conf/core-site.xml | 0 .../src/main/resources/hadoop-conf/hadoop-docs.properties | 0 .../test/java/org/apache/tinkerpop/gremlin/docs/GremlinConsoleTest.java | 0 .../test/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsTest.java | 0 .../org/apache/tinkerpop/gremlin/docs/GremlinPostprocessorTest.java | 0 .../org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java | 2 +- .../test/java/org/apache/tinkerpop/gremlin/docs/IntegrationTest.java | 0 .../tinkerpop/gremlin/docs/PluginDirectoryRestartHandlerTest.java | 0 .../java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilderTest.java | 0 .../tinkerpop-docs/src/test/resources/integration-fixture.asciidoc | 0 21 files changed, 3 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index bc6a31e690..beaac32145 100644 --- a/.gitignore +++ b/.gitignore @@ -29,8 +29,6 @@ __pycache__/ __version__.py .glv settings.xml -tools/* -!tools/tinkerpop-docs/ [Dd]ebug/ [Rr]elease/ [Oo]bj/ diff --git a/bin/process-docs.sh b/bin/process-docs.sh index 10bd27c8a4..0a47a5ac2d 100755 --- a/bin/process-docs.sh +++ b/bin/process-docs.sh @@ -199,7 +199,7 @@ org.apache.tinkerpop.gremlin.sparql.jsr223.SparqlGremlinPlugin EOF # 5. Copy hadoop config to console classpath -HADOOP_CONF_SRC="tools/tinkerpop-docs/src/main/resources/hadoop-conf" +HADOOP_CONF_SRC="docs/tinkerpop-docs/src/main/resources/hadoop-conf" cp "${HADOOP_CONF_SRC}/core-site.xml" "${CONSOLE_HOME}/conf/" cp "${HADOOP_CONF_SRC}/hadoop-docs.properties" "${CONSOLE_HOME}/conf/" diff --git a/docs/src/dev/developer/development-environment.asciidoc b/docs/src/dev/developer/development-environment.asciidoc index c7748ac728..c9759d67cd 100644 --- a/docs/src/dev/developer/development-environment.asciidoc +++ b/docs/src/dev/developer/development-environment.asciidoc @@ -121,7 +121,7 @@ an issue when working with SNAPSHOT dependencies. === Documentation Environment The core of the documentation generation process is an link:https://asciidoctor.org/[AsciidoctorJ] extension -(`tools/tinkerpop-docs`) which walks each AsciiDoc book, executes the `[gremlin-groovy]` code blocks against a long-lived +(`docs/tinkerpop-docs`) which walks each AsciiDoc book, executes the `[gremlin-groovy]` code blocks against a long-lived Gremlin Console subprocess, and renders the console output as tabbed HTML. The orchestration script `bin/process-docs.sh` wraps this and acts as the entrypoint: it validates the Gremlin Console and Gremlin Server distributions, installs the required plugins into the console, starts a Gremlin Server (for the `:remote` examples) and diff --git a/tools/tinkerpop-docs/pom.xml b/docs/tinkerpop-docs/pom.xml similarity index 100% rename from tools/tinkerpop-docs/pom.xml rename to docs/tinkerpop-docs/pom.xml diff --git a/tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/ConsoleRestartHandler.java b/docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/ConsoleRestartHandler.java similarity index 100% rename from tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/ConsoleRestartHandler.java rename to docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/ConsoleRestartHandler.java diff --git a/tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinConsole.java b/docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinConsole.java similarity index 100% rename from tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinConsole.java rename to docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinConsole.java diff --git a/tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsExtension.java b/docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsExtension.java similarity index 100% rename from tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsExtension.java rename to docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsExtension.java diff --git a/tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessor.java b/docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessor.java similarity index 100% rename from tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessor.java rename to docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessor.java diff --git a/tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandler.java b/docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandler.java similarity index 100% rename from tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandler.java rename to docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandler.java diff --git a/tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilder.java b/docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilder.java similarity index 100% rename from tools/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilder.java rename to docs/tinkerpop-docs/src/main/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilder.java diff --git a/tools/tinkerpop-docs/src/main/resources/META-INF/services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry b/docs/tinkerpop-docs/src/main/resources/META-INF/services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry similarity index 100% rename from tools/tinkerpop-docs/src/main/resources/META-INF/services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry rename to docs/tinkerpop-docs/src/main/resources/META-INF/services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry diff --git a/tools/tinkerpop-docs/src/main/resources/hadoop-conf/core-site.xml b/docs/tinkerpop-docs/src/main/resources/hadoop-conf/core-site.xml similarity index 100% rename from tools/tinkerpop-docs/src/main/resources/hadoop-conf/core-site.xml rename to docs/tinkerpop-docs/src/main/resources/hadoop-conf/core-site.xml diff --git a/tools/tinkerpop-docs/src/main/resources/hadoop-conf/hadoop-docs.properties b/docs/tinkerpop-docs/src/main/resources/hadoop-conf/hadoop-docs.properties similarity index 100% rename from tools/tinkerpop-docs/src/main/resources/hadoop-conf/hadoop-docs.properties rename to docs/tinkerpop-docs/src/main/resources/hadoop-conf/hadoop-docs.properties diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinConsoleTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinConsoleTest.java similarity index 100% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinConsoleTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinConsoleTest.java diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsTest.java similarity index 100% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinDocsTest.java diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessorTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessorTest.java similarity index 100% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessorTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinPostprocessorTest.java diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java similarity index 99% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java index e22dcb551c..99f7e92550 100644 --- a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java +++ b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/GremlinTreeprocessorTest.java @@ -82,7 +82,7 @@ public class GremlinTreeprocessorTest { final String input = "= Test\n\n[gremlin-groovy]\n----\n1+1\n----\n"; final String result = asciidoctor.convert(input, Options.builder().build()); assertThat(result, is(notNullValue())); - assertThat(executor.statements.contains("graph = TinkerGraph.open()"), is(true)); + assertThat(executor.statements.contains("graph = TinkerGraph.open(conf)"), is(true)); assertThat(executor.statements.contains("g = graph.traversal()"), is(true)); } } diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/IntegrationTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/IntegrationTest.java similarity index 100% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/IntegrationTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/IntegrationTest.java diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandlerTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandlerTest.java similarity index 100% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandlerTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/PluginDirectoryRestartHandlerTest.java diff --git a/tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilderTest.java b/docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilderTest.java similarity index 100% rename from tools/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilderTest.java rename to docs/tinkerpop-docs/src/test/java/org/apache/tinkerpop/gremlin/docs/TabbedHtmlBuilderTest.java diff --git a/tools/tinkerpop-docs/src/test/resources/integration-fixture.asciidoc b/docs/tinkerpop-docs/src/test/resources/integration-fixture.asciidoc similarity index 100% rename from tools/tinkerpop-docs/src/test/resources/integration-fixture.asciidoc rename to docs/tinkerpop-docs/src/test/resources/integration-fixture.asciidoc
