You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2020/07/13 19:07:33 UTC
[incubator-datasketches-website] branch master updated: Remove
duplicate links in ToC. Add System Integrations at top level.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-website.git
The following commit(s) were added to refs/heads/master by this push:
new 7aeed04 Remove duplicate links in ToC. Add System Integrations at top level.
7aeed04 is described below
commit 7aeed0479b3f2effa3fc716f0b60a12ea95f0573
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Mon Jul 13 12:07:04 2020 -0700
Remove duplicate links in ToC. Add System Integrations at top level.
---
_includes/toc.html | 13 +++++++------
.../java/org/apache/datasketches/docgen/TocGenerator.java | 9 +++++----
src/main/resources/docgen/toc.json | 12 ++++++------
3 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/_includes/toc.html b/_includes/toc.html
index d1d22f7..ea27b03 100644
--- a/_includes/toc.html
+++ b/_includes/toc.html
@@ -82,7 +82,6 @@
<li><a href="{{site.docs_dir}}/HLL/HllCppExample.html">•HLL Sketch C++ Example</a></li>
<li><a href="{{site.docs_dir}}/HLL/HllPigUDFs.html">•HLL Sketch Pig UDFs</a></li>
<li><a href="{{site.docs_dir}}/HLL/HllHiveUDFs.html">•HLL Sketch Hive UDFs</a></li>
- <li><a href="{{site.docs_dir}}/DruidIntegration.html">•Using Sketches in Druid</a></li>
</div>
<p id="hll-studies">
@@ -110,7 +109,6 @@
<li><a href="{{site.docs_dir}}/Theta/ThetaSparkExample.html">•Theta Sketch Spark Example</a></li>
<li><a href="{{site.docs_dir}}/Theta/ThetaPigUDFs.html">•Theta Sketch Pig UDFs</a></li>
<li><a href="{{site.docs_dir}}/Theta/ThetaHiveUDFs.html">•Theta Sketch Hive UDFs</a></li>
- <li><a href="{{site.docs_dir}}/DruidIntegration.html">•Using Sketches in Druid</a></li>
</div>
<p id="kmv-tutorial">
@@ -184,10 +182,8 @@
<div class="collapse" id="collapse_tuple_examples">
<li><a href="{{site.docs_dir}}/Tuple/TupleJavaExample.html">•Tuple Java Example</a></li>
<li><a href="{{site.docs_dir}}/Tuple/TupleEngagementExample.html">•Tuple Engagement Example</a></li>
- <li><a href="{{site.docs_dir}}/Frequency/FrequentDistinctTuplesSketch.html">•Frequent Distinct Tuples Sketch</a></li>
<li><a href="{{site.docs_dir}}/Tuple/TuplePigUDFs.html">•Tuple Pig UDFs</a></li>
<li><a href="{{site.docs_dir}}/Tuple/TupleHiveUDFs.html">•Tuple Hive UDFs</a></li>
- <li><a href="{{site.docs_dir}}/DruidIntegration.html">•Using Sketches in Druid</a></li>
</div>
</div>
</div>
@@ -215,7 +211,6 @@
<li><a href="{{site.docs_dir}}/Frequency/FrequentItemsCppExample.html">•Frequent Items C++ Example</a></li>
<li><a href="{{site.docs_dir}}/Frequency/FrequentItemsPigUDFs.html">•Frequent Items Pig UDFs</a></li>
<li><a href="{{site.docs_dir}}/Frequency/FrequentItemsHiveUDFs.html">•Frequent Items Hive UDFs</a></li>
- <li><a href="{{site.docs_dir}}/DruidIntegration.html">•Using Sketches in Druid</a></li>
</div>
</div>
@@ -242,7 +237,6 @@
<li><a href="{{site.docs_dir}}/Quantiles/QuantilesCppExample.html">•KLL Quantiles Sketch C++ Example</a></li>
<li><a href="{{site.docs_dir}}/Quantiles/QuantilesPigUDFs.html">•Quantiles Sketch Pig UDFs</a></li>
<li><a href="{{site.docs_dir}}/Quantiles/QuantilesHiveUDFs.html">•Quantiles Sketch Hive UDFs</a></li>
- <li><a href="{{site.docs_dir}}/DruidIntegration.html">•Using Sketches in Druid</a></li>
</div>
<p id="quantiles-studies">
@@ -287,6 +281,13 @@
</div>
</div>
+ <p id="system-integrations">
+ <a data-toggle="collapse" class="menu collapsed" href="#collapse_system_integrations">System Integrations</a>
+ </p>
+ <div class="collapse" id="collapse_system_integrations">
+ <li><a href="{{site.docs_dir}}/DruidIntegration.html">•Using Sketches in Druid</a></li>
+ </div>
+
<p id="community">
<a data-toggle="collapse" class="menu collapsed" href="#collapse_community">Community</a>
</p>
diff --git a/src/main/java/org/apache/datasketches/docgen/TocGenerator.java b/src/main/java/org/apache/datasketches/docgen/TocGenerator.java
index 779c466..9a2990c 100644
--- a/src/main/java/org/apache/datasketches/docgen/TocGenerator.java
+++ b/src/main/java/org/apache/datasketches/docgen/TocGenerator.java
@@ -44,13 +44,14 @@ public class TocGenerator {
/**
* To create the Table of Contents for the website:
* <ol>
- * <li>Edit the JSON source file (referenced below) for the structure you want.
- * Be careful not to use any HTML reserved symbols! </li>
- * <li>Note that the javascript required is located in the _includes directory.
+ * <li>Edit the JSON source file (referenced below) for the structure you want.</li>
+ * <li>Be careful not to use any HTML reserved symbols!</li>
+ * <li>All links in the ToC should be unique within the ToC.</li>
+ * <li>Note that the javascript required is located in the _includes directory.</li>
* <li>Execute this test. The result will be placed in the proper location as part of the web
* source.</li>
* <li>Stage the changes and push the web site source to origin.</li>
- * <li>Refresh your browser and confirm that the TOC is correct.
+ * <li>Refresh your browser and confirm that the TOC is correct.</li>
* </ol>
* @author Lee Rhodes
*/
diff --git a/src/main/resources/docgen/toc.json b/src/main/resources/docgen/toc.json
index 36e1227..dbd94cd 100644
--- a/src/main/resources/docgen/toc.json
+++ b/src/main/resources/docgen/toc.json
@@ -62,7 +62,6 @@
{"class":"Doc", "desc" : "HLL Sketch C++ Example", "dir" : "HLL", "file": "HllCppExample" },
{"class":"Doc", "desc" : "HLL Sketch Pig UDFs", "dir" : "HLL", "file": "HllPigUDFs" },
{"class":"Doc", "desc" : "HLL Sketch Hive UDFs", "dir" : "HLL", "file": "HllHiveUDFs" },
- {"class":"Doc", "desc" : "Using Sketches in Druid", "dir" : "", "file": "DruidIntegration" },
]
},
{ "class":"Dropdown", "desc" : "HLL Studies", "array":
@@ -86,7 +85,6 @@
{"class":"Doc", "desc" : "Theta Sketch Spark Example", "dir" : "Theta", "file": "ThetaSparkExample" },
{"class":"Doc", "desc" : "Theta Sketch Pig UDFs", "dir" : "Theta", "file": "ThetaPigUDFs" },
{"class":"Doc", "desc" : "Theta Sketch Hive UDFs", "dir" : "Theta", "file": "ThetaHiveUDFs" },
- {"class":"Doc", "desc" : "Using Sketches in Druid", "dir" : "", "file": "DruidIntegration" },
]
},
@@ -151,10 +149,8 @@
[
{"class":"Doc", "desc" : "Tuple Java Example", "dir" : "Tuple", "file": "TupleJavaExample" },
{"class":"Doc", "desc" : "Tuple Engagement Example", "dir" : "Tuple", "file": "TupleEngagementExample" },
- {"class":"Doc", "desc" : "Frequent Distinct Tuples Sketch", "dir" : "Frequency", "file": "FrequentDistinctTuplesSketch" },
{"class":"Doc", "desc" : "Tuple Pig UDFs", "dir" : "Tuple", "file": "TuplePigUDFs" },
{"class":"Doc", "desc" : "Tuple Hive UDFs", "dir" : "Tuple", "file": "TupleHiveUDFs" },
- {"class":"Doc", "desc" : "Using Sketches in Druid", "dir" : "", "file": "DruidIntegration" },
]
},
]
@@ -179,7 +175,6 @@
{"class":"Doc", "desc" : "Frequent Items C++ Example", "dir" : "Frequency", "file": "FrequentItemsCppExample" },
{"class":"Doc", "desc" : "Frequent Items Pig UDFs", "dir" : "Frequency", "file": "FrequentItemsPigUDFs" },
{"class":"Doc", "desc" : "Frequent Items Hive UDFs", "dir" : "Frequency", "file": "FrequentItemsHiveUDFs" },
- {"class":"Doc", "desc" : "Using Sketches in Druid", "dir" : "", "file": "DruidIntegration" },
]
},
]
@@ -204,7 +199,6 @@
{"class":"Doc", "desc" : "KLL Quantiles Sketch C++ Example", "dir" : "Quantiles", "file": "QuantilesCppExample" },
{"class":"Doc", "desc" : "Quantiles Sketch Pig UDFs", "dir" : "Quantiles", "file": "QuantilesPigUDFs" },
{"class":"Doc", "desc" : "Quantiles Sketch Hive UDFs", "dir" : "Quantiles", "file": "QuantilesHiveUDFs" },
- {"class":"Doc", "desc" : "Using Sketches in Druid", "dir" : "", "file": "DruidIntegration" },
]
},
{ "class":"Dropdown", "desc" : "Quantiles Studies", "array":
@@ -246,6 +240,12 @@
]
},
+ { "class":"Dropdown", "desc" : "System Integrations", "array":
+ [
+ {"class":"Doc", "desc" : "Using Sketches in Druid", "dir" : "", "file": "DruidIntegration" },
+ ]
+ },
+
{ "class":"Dropdown", "desc" : "Community", "array":
[
{"class":"Doc", "desc" : "Community", "dir" : "Community", "file": "index" },
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org