Author: spmallette
Date: Wed Jun 8 13:11:59 2016
New Revision: 1747390
URL: http://svn.apache.org/viewvc?rev=1747390&view=rev
Log:
Fixed formatting and toc modifications to TinkerPop dev docs.
Modified:
incubator/tinkerpop/site/docs/3.1.3-SNAPSHOT/dev/developer/index.html
incubator/tinkerpop/site/docs/3.2.1-SNAPSHOT/dev/developer/index.html
Modified: incubator/tinkerpop/site/docs/3.1.3-SNAPSHOT/dev/developer/index.html
URL:
http://svn.apache.org/viewvc/incubator/tinkerpop/site/docs/3.1.3-SNAPSHOT/dev/developer/index.html?rev=1747390&r1=1747389&r2=1747390&view=diff
==============================================================================
--- incubator/tinkerpop/site/docs/3.1.3-SNAPSHOT/dev/developer/index.html
(original)
+++ incubator/tinkerpop/site/docs/3.1.3-SNAPSHOT/dev/developer/index.html Wed
Jun 8 13:11:59 2016
@@ -813,12 +813,19 @@ span.line-numbers { border-right: 1px so
</li>
<li><a href="#_considering_code_changes">Considering Code Changes</a></li>
<li><a href="#_contributing_code_changes">Contributing Code Changes</a></li>
+</ul>
+</li>
+<li><a href="#_development_environment">Development Environment</a></li>
+<li>
+<ul class="sectlevel1">
<li><a href="#building-testing">Building and Testing</a></li>
<li><a href="#docker-integration">Docker Integration</a></li>
<li><a href="#_ide_setup_with_intellij">IDE Setup with Intellij</a></li>
+</ul>
+</li>
<li><a href="#_for_committers">For Committers</a></li>
<li>
-<ul class="sectlevel2">
+<ul class="sectlevel1">
<li><a href="#_communication">Communication</a></li>
<li><a href="#_release_notes">Release Notes</a></li>
<li><a href="#_branches">Branches</a></li>
@@ -829,19 +836,19 @@ span.line-numbers { border-right: 1px so
<li><a href="#_deprecation">Deprecation</a></li>
<li><a href="#_developing_tests">Developing Tests</a></li>
<li>
-<ul class="sectlevel3">
+<ul class="sectlevel2">
<li><a href="#_gremlin_language_test_cases">Gremlin Language Test
Cases</a></li>
</ul>
</li>
<li><a href="#rtc">Review then Commit</a></li>
<li>
-<ul class="sectlevel3">
+<ul class="sectlevel2">
<li><a href="#_pull_request_format">Pull Request Format</a></li>
</ul>
</li>
<li><a href="#dependencies">Dependencies</a></li>
<li>
-<ul class="sectlevel3">
+<ul class="sectlevel2">
<li><a href="#_source_license_and_notice">Source LICENSE and NOTICE</a></li>
<li><a href="#_binary_license_and_notice">Binary LICENSE and NOTICE</a></li>
</ul>
@@ -851,8 +858,6 @@ span.line-numbers { border-right: 1px so
</ul>
</li>
<li><a href="#_for_providers">For Providers</a></li>
-</ul>
-</li>
<li><a href="#_release_process">Release Process</a></li>
<li>
<ul class="sectlevel1">
@@ -932,7 +937,7 @@ As a quick acknowledgement, this section
<h3 id="_mailing_list_participation">Mailing List Participation</h3>
<div class="paragraph">
<p>TinkerPop has two mailing lists: <a
href="https://groups.google.com/forum/#!forum/gremlin-users";>gremlin-users</a>
and
-<a href="https://lists.apache.org/list.html?<a
href="mailto:d...@tinkerpop.apache.org";>d...@tinkerpop.apache.org</a>">dev</a>.
Subscribing to and
+<a
href="https://lists.apache.org/list.html?d...@tinkerpop.apache.org";>dev</a>.
Subscribing to and
participating on one or both of these mailing lists is a great way to
contribute to TinkerPop. Helping users with their
problems by answering their questions on gremlin-users is a great help to the
community and an easy way for
the community to become familiar with the contributor.</p>
@@ -1298,6 +1303,7 @@ and force pushing the branch.</p>
</div>
</div>
</div>
+<h1 id="_development_environment" class="sect0">Development Environment</h1>
<div class="sect1">
<h2 id="building-testing">Building and Testing</h2>
<div class="sectionbody">
@@ -1476,9 +1482,7 @@ install the <a href="http://plugins.jetb
</div>
</div>
</div>
-<div class="sect1">
-<h2 id="_for_committers">For Committers</h2>
-<div class="sectionbody">
+<h1 id="_for_committers" class="sect0">For Committers</h1>
<div class="imageblock">
<div class="content">
<img src="../../images/business-gremlin.png" alt="business gremlin"
width="400">
@@ -1487,8 +1491,9 @@ install the <a href="http://plugins.jetb
<div class="paragraph">
<p>The guidelines that follow apply to those with commit access to the main
repository:</p>
</div>
-<div class="sect2">
-<h3 id="_communication">Communication</h3>
+<div class="sect1">
+<h2 id="_communication">Communication</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop has a <a href="http://groups.google.com/group/gremlin-users";>user
mailing list</a> and a
<a
href="http://mail-archives.apache.org/mod_mbox/incubator-tinkerpop-dev/";>developer
mailing list</a>. As a committer,
@@ -1507,8 +1512,10 @@ post to the TinkerPop room in HipChat.
taken and added to the <a href="#meetings">Meetings</a> section of this
document using the pattern already established.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_release_notes">Release Notes</h3>
+</div>
+<div class="sect1">
+<h2 id="_release_notes">Release Notes</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>There is a two-pronged approach to maintaining the change log and preparing
the release notes.</p>
</div>
@@ -1538,8 +1545,10 @@ change.</p>
distinguished from other changes in the release notes.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_branches">Branches</h3>
+</div>
+<div class="sect1">
+<h2 id="_branches">Branches</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>The "master" branch is used for the main line of development and release
branches are constructed as needed
for ongoing maintenance work. If new to the project or are returning to it
after some time away, it may be good
@@ -1559,15 +1568,19 @@ a branch name prefix. This provides a u
<p>Developers should remove their own branches when they are no longer
needed.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_tags">Tags</h3>
+</div>
+<div class="sect1">
+<h2 id="_tags">Tags</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Tags are used for milestones, release candidates, and approved releases.
Please refrain from creating arbitrary
tags, as they produce permanent clutter.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_issue_tracker_conventions">Issue Tracker Conventions</h3>
+</div>
+<div class="sect1">
+<h2 id="_issue_tracker_conventions">Issue Tracker Conventions</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop uses Apache JIRA as its <a
href="https://issues.apache.org/jira/browse/TINKERPOP";>issue tracker</a>. JIRA
is a
very robust piece of software with many options and configurations. To
simplify usage and ensure consistency across
@@ -1637,16 +1650,20 @@ required improvements.</p>
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_code_style">Code Style</h3>
+</div>
+<div class="sect1">
+<h2 id="_code_style">Code Style</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Contributors should examine the current code base to determine what the
code style patterns are and should match their
style to what is already present. Of specific note however, TinkerPop does not
use "import wildcards" - IDEs should
be adjusted accordingly to not auto-wildcard the imports.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_build_server">Build Server</h3>
+</div>
+<div class="sect1">
+<h2 id="_build_server">Build Server</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop uses both <a href="https://travis-ci.com/";>Travis</a> and <a
href="https://www.appveyor.com/";>AppVeyor</a> for
<a href="https://en.wikipedia.org/wiki/Continuous_integration";>CI</a>
services. Travis validates builds on Ubuntu, while
@@ -1667,8 +1684,10 @@ AppVeyor validates builds on Windows. T
exceed the allowable times for builds on these servers.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_deprecation">Deprecation</h3>
+</div>
+<div class="sect1">
+<h2 id="_deprecation">Deprecation</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>When possible, committers should avoid direct "breaking" change (e.g.
removing a method from a class) and favor
deprecation. Deprecation should come with sufficient documentation and notice
especially when the change involves
@@ -1713,8 +1732,10 @@ call out this fact.</p>
prudent to schedule them into a release.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_developing_tests">Developing Tests</h3>
+</div>
+<div class="sect1">
+<h2 id="_developing_tests">Developing Tests</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop has a wide variety of test types that help validate its internal
code as well as external provider code.
There are "unit tests" and "integration tests". Unit tests execute on standard
runs of <code>mvn clean install</code>. These
@@ -1752,8 +1773,8 @@ for an example.</p>
</li>
</ul>
</div>
-<div class="sect3">
-<h4 id="_gremlin_language_test_cases">Gremlin Language Test Cases</h4>
+<div class="sect2">
+<h3 id="_gremlin_language_test_cases">Gremlin Language Test Cases</h3>
<div class="paragraph">
<p>When writing a test case for a Gremlin step, be sure to use the following
conventions.</p>
</div>
@@ -1815,8 +1836,10 @@ for an example.</p>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="rtc">Review then Commit</h3>
+</div>
+<div class="sect1">
+<h2 id="rtc">Review then Commit</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Code modifications must go through a <a
href="http://www.apache.org/foundation/glossary.html#ReviewThenCommit";>review-then-committ</a>
(RTC)
process before being merged into a release branch. All committers should
follow the pattern below, where "you" refers to the
@@ -1933,8 +1956,8 @@ require a review.</p>
that CTR was invoked and the reason for doing so. For example, "Invoking CTR
as this change encompasses minor
adjustments to text formatting."</p>
</div>
-<div class="sect3">
-<h4 id="_pull_request_format">Pull Request Format</h4>
+<div class="sect2">
+<h3 id="_pull_request_format">Pull Request Format</h3>
<div class="paragraph">
<p>When you submit a pull request, be sure it uses the following style.</p>
</div>
@@ -1988,8 +2011,10 @@ adjustments to text formatting."</p>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="dependencies">Dependencies</h3>
+</div>
+<div class="sect1">
+<h2 id="dependencies">Dependencies</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>There are many dependencies on other open source libraries in TinkerPop
modules. When adding dependencies or
altering the version of a dependency, developers must consider the
implications that may apply to the TinkerPop
@@ -2045,8 +2070,8 @@ and its distribution.</p>
</li>
</ul>
</div>
-<div class="sect3">
-<h4 id="_source_license_and_notice">Source LICENSE and NOTICE</h4>
+<div class="sect2">
+<h3 id="_source_license_and_notice">Source LICENSE and NOTICE</h3>
<div class="paragraph">
<p>As dependencies are not typically added to the source distribution (i.e.
the source zip distribution), there is
typically no need to edit source LICENSE/NOTICE when editing a TinkerPop
<code>pom.xml</code>. These files only need to be edited
@@ -2065,8 +2090,8 @@ that LICENSE in the root <code>/licenses
</ul>
</div>
</div>
-<div class="sect3">
-<h4 id="_binary_license_and_notice">Binary LICENSE and NOTICE</h4>
+<div class="sect2">
+<h3 id="_binary_license_and_notice">Binary LICENSE and NOTICE</h3>
<div class="paragraph">
<p>The binary LICENSE/NOTICE is perhaps most impacted by changes to the
various <code>pom.xml</code> files. After altering the
<code>pom.xml</code> file of any module, build both Gremlin Console and
Gremlin Server and examine the contents of both binary
@@ -2117,8 +2142,10 @@ of the Apache "Licensing How-to" for mor
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="documentation">Documentation</h3>
+</div>
+<div class="sect1">
+<h2 id="documentation">Documentation</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>The documentation for TinkerPop is stored in the git repository in
<code>docs/src/</code> and are then split into several
subdirectories, each representing a "book" (or its own publishable body of
work). If a new AsciiDoc file is added to
@@ -2139,8 +2166,10 @@ uploaded to the server and should preser
documentation.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="logging">Logging</h3>
+</div>
+<div class="sect1">
+<h2 id="logging">Logging</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop uses SLF4j for logging and typically leans back on Log4j as the
implementation. Configuring log outputs
for debugging purposes within tests can be altered by editing the
<code>log4j-test.properties</code> file in each module’s test
@@ -2151,17 +2180,12 @@ best for everyone’s general purpos
</div>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="_for_providers">For Providers</h2>
-<div class="sectionbody">
+<h1 id="_for_providers" class="sect0">For Providers</h1>
<div class="paragraph">
<p>Graph Providers are those who develop third-party systems and libraries on
top of the various TinkerPop APIs and
protocols. They manage their projects independently of TinkerPop in separate
repositories. Additional details for
providers can be found in the <a
href="http://tinkerpop.apache.org/docs/3.1.3-SNAPSHOT/dev/provider/";>Provider
Documentation</a>.</p>
</div>
-</div>
-</div>
<h1 id="_release_process" class="sect0">Release Process</h1>
<div class="paragraph">
<p>This document describes the steps required to release a version of
TinkerPop. The release is handled by a "release
@@ -3485,7 +3509,7 @@ roadmap:</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-06-07 17:17:50 -04:00
+Last updated 2016-06-08 08:59:42 -04:00
</div>
</div>
</body>
Modified: incubator/tinkerpop/site/docs/3.2.1-SNAPSHOT/dev/developer/index.html
URL:
http://svn.apache.org/viewvc/incubator/tinkerpop/site/docs/3.2.1-SNAPSHOT/dev/developer/index.html?rev=1747390&r1=1747389&r2=1747390&view=diff
==============================================================================
--- incubator/tinkerpop/site/docs/3.2.1-SNAPSHOT/dev/developer/index.html
(original)
+++ incubator/tinkerpop/site/docs/3.2.1-SNAPSHOT/dev/developer/index.html Wed
Jun 8 13:11:59 2016
@@ -813,12 +813,19 @@ span.line-numbers { border-right: 1px so
</li>
<li><a href="#_considering_code_changes">Considering Code Changes</a></li>
<li><a href="#_contributing_code_changes">Contributing Code Changes</a></li>
+</ul>
+</li>
+<li><a href="#_development_environment">Development Environment</a></li>
+<li>
+<ul class="sectlevel1">
<li><a href="#building-testing">Building and Testing</a></li>
<li><a href="#docker-integration">Docker Integration</a></li>
<li><a href="#_ide_setup_with_intellij">IDE Setup with Intellij</a></li>
+</ul>
+</li>
<li><a href="#_for_committers">For Committers</a></li>
<li>
-<ul class="sectlevel2">
+<ul class="sectlevel1">
<li><a href="#_communication">Communication</a></li>
<li><a href="#_release_notes">Release Notes</a></li>
<li><a href="#_branches">Branches</a></li>
@@ -829,20 +836,20 @@ span.line-numbers { border-right: 1px so
<li><a href="#_deprecation">Deprecation</a></li>
<li><a href="#_developing_tests">Developing Tests</a></li>
<li>
-<ul class="sectlevel3">
+<ul class="sectlevel2">
<li><a href="#_gremlin_language_test_cases">Gremlin Language Test
Cases</a></li>
</ul>
</li>
<li><a href="#_developing_benchmarks">Developing Benchmarks</a></li>
<li><a href="#rtc">Review then Commit</a></li>
<li>
-<ul class="sectlevel3">
+<ul class="sectlevel2">
<li><a href="#_pull_request_format">Pull Request Format</a></li>
</ul>
</li>
<li><a href="#dependencies">Dependencies</a></li>
<li>
-<ul class="sectlevel3">
+<ul class="sectlevel2">
<li><a href="#_source_license_and_notice">Source LICENSE and NOTICE</a></li>
<li><a href="#_binary_license_and_notice">Binary LICENSE and NOTICE</a></li>
</ul>
@@ -852,8 +859,6 @@ span.line-numbers { border-right: 1px so
</ul>
</li>
<li><a href="#_for_providers">For Providers</a></li>
-</ul>
-</li>
<li><a href="#_release_process">Release Process</a></li>
<li>
<ul class="sectlevel1">
@@ -936,7 +941,7 @@ As a quick acknowledgement, this section
<h3 id="_mailing_list_participation">Mailing List Participation</h3>
<div class="paragraph">
<p>TinkerPop has two mailing lists: <a
href="https://groups.google.com/forum/#!forum/gremlin-users";>gremlin-users</a>
and
-<a href="https://lists.apache.org/list.html?<a
href="mailto:d...@tinkerpop.apache.org";>d...@tinkerpop.apache.org</a>">dev</a>.
Subscribing to and
+<a
href="https://lists.apache.org/list.html?d...@tinkerpop.apache.org";>dev</a>.
Subscribing to and
participating on one or both of these mailing lists is a great way to
contribute to TinkerPop. Helping users with their
problems by answering their questions on gremlin-users is a great help to the
community and an easy way for
the community to become familiar with the contributor.</p>
@@ -1302,6 +1307,7 @@ and force pushing the branch.</p>
</div>
</div>
</div>
+<h1 id="_development_environment" class="sect0">Development Environment</h1>
<div class="sect1">
<h2 id="building-testing">Building and Testing</h2>
<div class="sectionbody">
@@ -1483,9 +1489,7 @@ install the <a href="http://plugins.jetb
</div>
</div>
</div>
-<div class="sect1">
-<h2 id="_for_committers">For Committers</h2>
-<div class="sectionbody">
+<h1 id="_for_committers" class="sect0">For Committers</h1>
<div class="imageblock">
<div class="content">
<img src="../../images/business-gremlin.png" alt="business gremlin"
width="400">
@@ -1494,8 +1498,9 @@ install the <a href="http://plugins.jetb
<div class="paragraph">
<p>The guidelines that follow apply to those with commit access to the main
repository:</p>
</div>
-<div class="sect2">
-<h3 id="_communication">Communication</h3>
+<div class="sect1">
+<h2 id="_communication">Communication</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop has a <a href="http://groups.google.com/group/gremlin-users";>user
mailing list</a> and a
<a
href="http://mail-archives.apache.org/mod_mbox/incubator-tinkerpop-dev/";>developer
mailing list</a>. As a committer,
@@ -1514,8 +1519,10 @@ post to the TinkerPop room in HipChat.
taken and added to the <a href="#meetings">Meetings</a> section of this
document using the pattern already established.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_release_notes">Release Notes</h3>
+</div>
+<div class="sect1">
+<h2 id="_release_notes">Release Notes</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>There is a two-pronged approach to maintaining the change log and preparing
the release notes.</p>
</div>
@@ -1545,8 +1552,10 @@ change.</p>
distinguished from other changes in the release notes.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_branches">Branches</h3>
+</div>
+<div class="sect1">
+<h2 id="_branches">Branches</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>The "master" branch is used for the main line of development and release
branches are constructed as needed
for ongoing maintenance work. If new to the project or are returning to it
after some time away, it may be good
@@ -1566,15 +1575,19 @@ a branch name prefix. This provides a u
<p>Developers should remove their own branches when they are no longer
needed.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_tags">Tags</h3>
+</div>
+<div class="sect1">
+<h2 id="_tags">Tags</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Tags are used for milestones, release candidates, and approved releases.
Please refrain from creating arbitrary
tags, as they produce permanent clutter.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_issue_tracker_conventions">Issue Tracker Conventions</h3>
+</div>
+<div class="sect1">
+<h2 id="_issue_tracker_conventions">Issue Tracker Conventions</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop uses Apache JIRA as its <a
href="https://issues.apache.org/jira/browse/TINKERPOP";>issue tracker</a>. JIRA
is a
very robust piece of software with many options and configurations. To
simplify usage and ensure consistency across
@@ -1644,16 +1657,20 @@ required improvements.</p>
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_code_style">Code Style</h3>
+</div>
+<div class="sect1">
+<h2 id="_code_style">Code Style</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Contributors should examine the current code base to determine what the
code style patterns are and should match their
style to what is already present. Of specific note however, TinkerPop does not
use "import wildcards" - IDEs should
be adjusted accordingly to not auto-wildcard the imports.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_build_server">Build Server</h3>
+</div>
+<div class="sect1">
+<h2 id="_build_server">Build Server</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop uses both <a href="https://travis-ci.com/";>Travis</a> and <a
href="https://www.appveyor.com/";>AppVeyor</a> for
<a href="https://en.wikipedia.org/wiki/Continuous_integration";>CI</a>
services. Travis validates builds on Ubuntu, while
@@ -1674,8 +1691,10 @@ AppVeyor validates builds on Windows. T
exceed the allowable times for builds on these servers.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_deprecation">Deprecation</h3>
+</div>
+<div class="sect1">
+<h2 id="_deprecation">Deprecation</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>When possible, committers should avoid direct "breaking" change (e.g.
removing a method from a class) and favor
deprecation. Deprecation should come with sufficient documentation and notice
especially when the change involves
@@ -1720,8 +1739,10 @@ call out this fact.</p>
prudent to schedule them into a release.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_developing_tests">Developing Tests</h3>
+</div>
+<div class="sect1">
+<h2 id="_developing_tests">Developing Tests</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop has a wide variety of test types that help validate its internal
code as well as external provider code.
There are "unit tests" and "integration tests". Unit tests execute on standard
runs of <code>mvn clean install</code>. These
@@ -1759,8 +1780,8 @@ for an example.</p>
</li>
</ul>
</div>
-<div class="sect3">
-<h4 id="_gremlin_language_test_cases">Gremlin Language Test Cases</h4>
+<div class="sect2">
+<h3 id="_gremlin_language_test_cases">Gremlin Language Test Cases</h3>
<div class="paragraph">
<p>When writing a test case for a Gremlin step, be sure to use the following
conventions.</p>
</div>
@@ -1822,8 +1843,10 @@ for an example.</p>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="_developing_benchmarks">Developing Benchmarks</h3>
+</div>
+<div class="sect1">
+<h2 id="_developing_benchmarks">Developing Benchmarks</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Benchmarks are a useful tool to track performance between TinkerPop
versions and also as tools to aid development
decision making. TinkerPop uses <a
href="http://openjdk.java.net/projects/code-tools/jmh/";>OpenJDK JMH</a> for
benchmark development.
@@ -1866,8 +1889,10 @@ that may be used as building blocks for
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="rtc">Review then Commit</h3>
+</div>
+<div class="sect1">
+<h2 id="rtc">Review then Commit</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>Code modifications must go through a <a
href="http://www.apache.org/foundation/glossary.html#ReviewThenCommit";>review-then-committ</a>
(RTC)
process before being merged into a release branch. All committers should
follow the pattern below, where "you" refers to the
@@ -1984,8 +2009,8 @@ require a review.</p>
that CTR was invoked and the reason for doing so. For example, "Invoking CTR
as this change encompasses minor
adjustments to text formatting."</p>
</div>
-<div class="sect3">
-<h4 id="_pull_request_format">Pull Request Format</h4>
+<div class="sect2">
+<h3 id="_pull_request_format">Pull Request Format</h3>
<div class="paragraph">
<p>When you submit a pull request, be sure it uses the following style.</p>
</div>
@@ -2039,8 +2064,10 @@ adjustments to text formatting."</p>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="dependencies">Dependencies</h3>
+</div>
+<div class="sect1">
+<h2 id="dependencies">Dependencies</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>There are many dependencies on other open source libraries in TinkerPop
modules. When adding dependencies or
altering the version of a dependency, developers must consider the
implications that may apply to the TinkerPop
@@ -2096,8 +2123,8 @@ and its distribution.</p>
</li>
</ul>
</div>
-<div class="sect3">
-<h4 id="_source_license_and_notice">Source LICENSE and NOTICE</h4>
+<div class="sect2">
+<h3 id="_source_license_and_notice">Source LICENSE and NOTICE</h3>
<div class="paragraph">
<p>As dependencies are not typically added to the source distribution (i.e.
the source zip distribution), there is
typically no need to edit source LICENSE/NOTICE when editing a TinkerPop
<code>pom.xml</code>. These files only need to be edited
@@ -2116,8 +2143,8 @@ that LICENSE in the root <code>/licenses
</ul>
</div>
</div>
-<div class="sect3">
-<h4 id="_binary_license_and_notice">Binary LICENSE and NOTICE</h4>
+<div class="sect2">
+<h3 id="_binary_license_and_notice">Binary LICENSE and NOTICE</h3>
<div class="paragraph">
<p>The binary LICENSE/NOTICE is perhaps most impacted by changes to the
various <code>pom.xml</code> files. After altering the
<code>pom.xml</code> file of any module, build both Gremlin Console and
Gremlin Server and examine the contents of both binary
@@ -2168,8 +2195,10 @@ of the Apache "Licensing How-to" for mor
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="documentation">Documentation</h3>
+</div>
+<div class="sect1">
+<h2 id="documentation">Documentation</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>The documentation for TinkerPop is stored in the git repository in
<code>docs/src/</code> and are then split into several
subdirectories, each representing a "book" (or its own publishable body of
work). If a new AsciiDoc file is added to
@@ -2190,8 +2219,10 @@ uploaded to the server and should preser
documentation.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="logging">Logging</h3>
+</div>
+<div class="sect1">
+<h2 id="logging">Logging</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>TinkerPop uses SLF4j for logging and typically leans back on Log4j as the
implementation. Configuring log outputs
for debugging purposes within tests can be altered by editing the
<code>log4j-test.properties</code> file in each module’s test
@@ -2202,17 +2233,12 @@ best for everyone’s general purpos
</div>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="_for_providers">For Providers</h2>
-<div class="sectionbody">
+<h1 id="_for_providers" class="sect0">For Providers</h1>
<div class="paragraph">
<p>Graph Providers are those who develop third-party systems and libraries on
top of the various TinkerPop APIs and
protocols. They manage their projects independently of TinkerPop in separate
repositories. Additional details for
providers can be found in the <a
href="http://tinkerpop.apache.org/docs/3.2.1-SNAPSHOT/dev/provider/";>Provider
Documentation</a>.</p>
</div>
-</div>
-</div>
<h1 id="_release_process" class="sect0">Release Process</h1>
<div class="paragraph">
<p>This document describes the steps required to release a version of
TinkerPop. The release is handled by a "release
@@ -3536,7 +3562,7 @@ roadmap:</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-06-07 17:21:23 -04:00
+Last updated 2016-06-08 09:08:57 -04:00
</div>
</div>
</body>
