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/03/26 01:24:21 UTC
[incubator-datasketches-website] 02/02: More Refactoring of ToC.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch MoreRefactor
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-website.git
commit 81a1bdd5b1efe558570ad370aa77d4ebc2525990
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Wed Mar 25 18:23:43 2020 -0700
More Refactoring of ToC.
---
_includes/nav_bar.html | 2 +-
docs/Architecture/KeyFeatures.md | 2 +-
docs/{ => Architecture}/LargeScale.md | 0
docs/{ => Architecture}/MajorSketchFamilies.md | 0
docs/{ => Background}/SketchElements.md | 0
docs/{ => Background}/SketchOrigins.md | 0
docs/{ => Background}/TheChallenge.md | 2 +-
docs/{ => Community}/WhoUses.md | 0
docs/Community/index.md | 6 ++--
index.md | 4 +--
src/main/resources/docgen/toc.json | 40 ++++++++++++++------------
11 files changed, 31 insertions(+), 25 deletions(-)
diff --git a/_includes/nav_bar.html b/_includes/nav_bar.html
index 475131c..f5cb7ba 100644
--- a/_includes/nav_bar.html
+++ b/_includes/nav_bar.html
@@ -14,7 +14,7 @@
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li>
- <a href="/docs/TheChallenge.html">
+ <a href="/docs/Background/TheChallenge.html">
<span class="fa fa-info-circle"></span> DOCUMENTATION</a>
</li>
<li>
diff --git a/docs/Architecture/KeyFeatures.md b/docs/Architecture/KeyFeatures.md
index a29e6ca..2a5816c 100644
--- a/docs/Architecture/KeyFeatures.md
+++ b/docs/Architecture/KeyFeatures.md
@@ -28,7 +28,7 @@ layout: doc_page
* Please refer to the [Sketch Criteria]({{site.docs_dir}}/Architecture/SketchCriteria.html) for the criteria for sketches to be included in the library.
* Query results are <b>approximate</b> but within well defined error bounds that are user
configurable by trading off sketch size with accuracy.
-* Designed for <a href="{{site.docs_dir}}/LargeScale.html">Large-scale</a> computing environments
+* Designed for <a href="{{site.docs_dir}}/Architecture/LargeScale.html">Large-scale</a> computing environments
that must handle <b>Big Data</b>, e.g.,
<a href="https://hadoop.apache.org/">Hadoop</a>,
<a href="https://pig.apache.org/">Pig</a>,
diff --git a/docs/LargeScale.md b/docs/Architecture/LargeScale.md
similarity index 100%
rename from docs/LargeScale.md
rename to docs/Architecture/LargeScale.md
diff --git a/docs/MajorSketchFamilies.md b/docs/Architecture/MajorSketchFamilies.md
similarity index 100%
rename from docs/MajorSketchFamilies.md
rename to docs/Architecture/MajorSketchFamilies.md
diff --git a/docs/SketchElements.md b/docs/Background/SketchElements.md
similarity index 100%
rename from docs/SketchElements.md
rename to docs/Background/SketchElements.md
diff --git a/docs/SketchOrigins.md b/docs/Background/SketchOrigins.md
similarity index 100%
rename from docs/SketchOrigins.md
rename to docs/Background/SketchOrigins.md
diff --git a/docs/TheChallenge.md b/docs/Background/TheChallenge.md
similarity index 97%
rename from docs/TheChallenge.md
rename to docs/Background/TheChallenge.md
index 9b924b5..d6a90d8 100644
--- a/docs/TheChallenge.md
+++ b/docs/Background/TheChallenge.md
@@ -67,7 +67,7 @@ __If an approximate answer is acceptable, then it is possible that there are alg
This, of course, assumes that you care about query responsiveness and speed; that you care about resource utilization; and if you need to accept some approximation, that you care about knowing something about the accuracy that you end up with.
-[Sketches]({{site.docs_dir}}/SketchOrigins.html), the informal name for these algorithms, offer an excellent solution to these types of queries, and in some cases may be the only solution.
+[Sketches]({{site.docs_dir}}/Background/SketchOrigins.html), the informal name for these algorithms, offer an excellent solution to these types of queries, and in some cases may be the only solution.
Instead of requiring to keep such enormous data on-hand, sketches have small data structures that are usually kilobytes in size, orders-of-magnitude smaller than required by the exact solutions.
Sketches are also streaming algorithms, in that they only need to see each incoming item once.
diff --git a/docs/WhoUses.md b/docs/Community/WhoUses.md
similarity index 100%
rename from docs/WhoUses.md
rename to docs/Community/WhoUses.md
diff --git a/docs/Community/index.md b/docs/Community/index.md
index 1cbe0fd..099fe27 100644
--- a/docs/Community/index.md
+++ b/docs/Community/index.md
@@ -22,7 +22,7 @@ There are many ways that are available for our community to communicate with eac
* **datasketches** This is for use similar to the Users Mailing List above.
* **datasketches-dev** This is for use similar to the Developers Mailing List.
<br/><br/>
-* **[GitHub Components]({{site.docs_dir}}/Architecture/Components.html):** Our library is made up of components that are partitioned into GitHub repositories. If you have a specific issue or bug report that impacts only one of these components please open an issue on the respective component. If you are a developer and wish to submit a PR, please choose the appropriate repository.
+
## Contributing
@@ -31,7 +31,9 @@ We are always open to contributions from our community. Contributions can be of
We are also open to the submission of entirely new sketch algorithms. If you have a sketch algorithm (or a significant enhancement of our current algorithms), please read our [Sketch Criteria]({{site.docs_dir}}/Architecture/SketchCriteria.html) and contact us on our [dev]({{page.dev}}) list.
### What to work on
-We have three TODO lists for [Java](https://github.com/apache/incubator-datasketches-java/projects/1), [C++](https://github.com/apache/incubator-datasketches-cpp/projects/1) and the [Website](https://github.com/apache/incubator-datasketches-website/projects/1). Please check these out for potential contribution!
+* **[GitHub Components]({{site.docs_dir}}/Architecture/Components.html):** Our library is made up of components that are partitioned into GitHub repositories. If you have a specific issue or bug report that impacts only one of these components please open an issue on the respective component. If you are a developer and wish to submit a PR, please choose the appropriate repository.
+
+* We have three TODO lists for [Java](https://github.com/apache/incubator-datasketches-java/projects/1), [C++](https://github.com/apache/incubator-datasketches-cpp/projects/1) and the [Website](https://github.com/apache/incubator-datasketches-website/projects/1). Please check these out for potential contribution!
### Getting your proposed changes accepted
diff --git a/index.md b/index.md
index f7c5313..0bb500c 100644
--- a/index.md
+++ b/index.md
@@ -45,7 +45,7 @@ layout: front_page
<p><b>The Business Challenge:</b> Analyzing Big Data Quickly.</p>
<p>In the analysis of big data there are often problem queries that don’t scale because they require huge compute resources and time to generate exact results. Examples include <i>count distinct</i>, quantiles, most frequent items, joins, matrix computations, and graph analysis.</p>
-<p>If approximate results are acceptable, there is a class of specialized algorithms, called streaming algorithms, or <a href="/docs/SketchOrigins.html">sketches</a> that can produce results orders-of magnitude faster and with mathematically proven error bounds. For interactive queries there may not be other viable alternatives, and in the case of real-time analysis, sketches are the only known solution.</p>
+<p>If approximate results are acceptable, there is a class of specialized algorithms, called streaming algorithms, or <a href="/docs/Background/SketchOrigins.html">sketches</a> that can produce results orders-of magnitude faster and with mathematically proven error bounds. For interactive queries there may not be other viable alternatives, and in the case of real-time analysis, sketches are the only known solution.</p>
<p>For any system that needs to extract useful information from big data these sketches are a required toolkit that should be tightly integrated into their analysis capabilities. This technology has helped Yahoo (Verizon Media) successfully reduce data processing times from days to hours or minutes on a number of its internal platforms.</p>
@@ -58,7 +58,7 @@ layout: front_page
<span class="fa fa-fighter-jet fa-4x"></span><br>
<h2>Fast</h2>
</a></p>
- <p class="text-justify"><a href="/docs/SketchOrigins.html">Sketches</a> are <i>fast</i>.
+ <p class="text-justify"><a href="/docs/Background/SketchOrigins.html">Sketches</a> are <i>fast</i>.
The sketch algorithms in this library process data in a single pass and are suitable for
both real-time and batch.
Sketches enable streaming computation of set expression cardinalities, quantiles, frequency estimation and more.
diff --git a/src/main/resources/docgen/toc.json b/src/main/resources/docgen/toc.json
index f3af087..eca526b 100644
--- a/src/main/resources/docgen/toc.json
+++ b/src/main/resources/docgen/toc.json
@@ -1,28 +1,27 @@
{ "class":"TOC", "array":
[
- { "class":"Dropdown", "desc" : "Overview", "array":
+ { "class":"Dropdown", "desc" : "Background", "array":
[
- {"class":"Doc", "desc" : "The Challenge", "dir" : "", "file": "TheChallenge" },
- {"class":"Doc", "desc" : "The Major Sketch Families", "dir" : "", "file": "MajorSketchFamilies" },
- {"class":"Doc", "desc" : "Sketch Origins", "dir" : "", "file": "SketchOrigins" },
- {"class":"Doc", "desc" : "Sketch Elements", "dir" : "", "file": "SketchElements" },
- {"class":"Doc", "desc" : "Large Scale Computing", "dir" : "", "file": "LargeScale" },
+ {"class":"Doc", "desc" : "The Challenge", "dir" : "Background", "file": "TheChallenge" },
+ {"class":"Doc", "desc" : "Sketch Origins", "dir" : "Background", "file": "SketchOrigins" },
+ {"class":"Doc", "desc" : "Sketch Elements", "dir" : "Background", "file": "SketchElements" },
{"class":"Doc", "desc" : "Overview Slide Deck", "dir" : "", "file": "DataSketches_deck", "pdf":"true" },
- {"class":"Doc", "desc" : "Who Uses", "dir" : "", "file": "WhoUses" },
]
},
{ "class":"Dropdown", "desc" : "Architecture And Design", "array":
[
- {"class":"Doc", "desc" : "Key Features", "dir" : "Architecture", "file": "KeyFeatures" },
- {"class":"Doc", "desc" : "Sketch Features Matrix", "dir" : "Architecture", "file": "SketchFeaturesMatrix" },
- {"class":"Doc", "desc" : "Components", "dir" : "Architecture", "file": "Components" },
- {"class":"Doc", "desc" : "Sketches by Component", "dir" : "Architecture", "file": "SketchesByComponent" },
- {"class":"Doc", "desc" : "Sketch Criteria", "dir" : "Architecture", "file": "SketchCriteria" },
+ {"class":"Doc", "desc" : "The Major Sketch Families", "dir" : "Architecture", "file": "MajorSketchFamilies" },
+ {"class":"Doc", "desc" : "Large Scale Computing", "dir" : "Architecture", "file": "LargeScale" },
+ {"class":"Doc", "desc" : "Key Features", "dir" : "Architecture", "file": "KeyFeatures" },
+ {"class":"Doc", "desc" : "Sketch Features Matrix", "dir" : "Architecture", "file": "SketchFeaturesMatrix" },
+ {"class":"Doc", "desc" : "Components", "dir" : "Architecture", "file": "Components" },
+ {"class":"Doc", "desc" : "Sketches by Component", "dir" : "Architecture", "file": "SketchesByComponent" },
+ {"class":"Doc", "desc" : "Sketch Criteria", "dir" : "Architecture", "file": "SketchCriteria" },
{ "class":"Dropdown", "desc" : "Memory Package", "array":
[
- {"class":"Doc", "desc" : "Memory Package", "dir" : "Memory", "file": "MemoryPackage" },
- {"class":"Doc", "desc" : "Memory Package Performance", "dir" : "Memory", "file": "MemoryPerformance" },
+ {"class":"Doc", "desc" : "Memory Package", "dir" : "Memory", "file": "MemoryPackage" },
+ {"class":"Doc", "desc" : "Memory Package Performance", "dir" : "Memory", "file": "MemoryPerformance" },
]
},
{"class":"Doc", "desc" : "Notes on Order Sensitivity", "dir" : "Architecture", "file": "OrderSensitivity" },
@@ -45,7 +44,7 @@
{"class":"Doc", "desc" : "CPC Sketch Java Example", "dir" : "CPC", "file": "CpcJavaExample" },
{"class":"Doc", "desc" : "CPC Sketch C++ Example", "dir" : "CPC", "file": "CpcCppExample" },
{"class":"Doc", "desc" : "CPC Sketch Pig UDFs", "dir" : "CPC", "file": "CpcPigExample" },
- {"class":"Doc", "desc" : "CPC Sketch Hive UDFs", "dir" : "CPC", "file": "CpcHiveExample" }
+ {"class":"Doc", "desc" : "CPC Sketch Hive UDFs", "dir" : "CPC", "file": "CpcHiveExample" },
]
},
]
@@ -138,7 +137,7 @@
{"class":"Doc", "desc" : "Merging Algorithm Notes", "dir" : "Theta", "file": "ThetaMergingAlgorithm" },
{"class":"Doc", "desc" : "Theta References", "dir" : "Theta", "file": "ThetaReferences" },
]
- }
+ },
]
},
@@ -186,7 +185,7 @@
[
{"class":"Doc", "desc" : "Frequent Distinct Tuples Sketch", "dir" : "Frequency", "file": "FrequentDistinctTuplesSketch" },
]
- }
+ },
]
},
@@ -206,11 +205,13 @@
},
{ "class":"Dropdown", "desc" : "Quantiles Studies", "array":
[
+ {"class":"Doc", "desc" : "Definitions for Quantiles Studies", "dir" : "Quantiles", "file": "Definitions"},
{"class":"Doc", "desc" : "New KLL sketch and comparison with DoublesSketch", "dir" : "Quantiles", "file": "KLLSketch" },
{"class":"Doc", "desc" : "KLL sketch vs t-digest", "dir" : "Quantiles", "file": "KllSketchVsTDigest" },
{"class":"Doc", "desc" : "Druid Approximate Histogram", "dir" : "Quantiles", "file": "DruidApproxHistogramStudy" },
{"class":"Doc", "desc" : "Moments Sketch Study", "dir" : "Quantiles", "file": "MomentsSketchStudy" },
{"class":"Doc", "desc" : "Quantiles StreamA Study", "dir" : "Quantiles", "file": "QuantilesStreamAStudy" },
+ {"class":"Doc", "desc" : "Exact Quantiles for Studies", "dir" : "Quantiles", "file": "ExactQuantiles" },
]
},
{ "class":"Dropdown", "desc" : "Quantiles Sketch Theory", "array":
@@ -218,7 +219,7 @@
{"class":"Doc", "desc" : "Optimal Quantile Approximation in Streams", "dir" : "", "file": "Quantiles_KLL", "pdf":"true" },
{"class":"Doc", "desc" : "Quantiles References", "dir" : "Quantiles", "file": "QuantilesReferences" },
]
- }
+ },
]
},
@@ -244,6 +245,9 @@
{ "class":"Dropdown", "desc" : "Community", "array":
[
{"class":"Doc", "desc" : "Community", "dir" : "Community", "file": "index" },
+ {"class":"Doc", "desc" : "Downloads", "dir" : "Community", "file": "Downloads"},
+ {"class":"Doc", "desc" : "Transitioning from prior GitHub Site", "dir" : "Community", "file" : "Transitioning"},
+ {"class":"Doc", "desc" : "Who Uses", "dir" : "Community", "file": "WhoUses" },
]
},
{ "class":"Dropdown", "desc" : "Research", "array":
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org