This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datasketches-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 7e3041b Automatic Site Publish by Buildbot
7e3041b is described below
commit 7e3041bb18d40ceba5663b21dbbb9185ce0b28e8
Author: buildbot <[email protected]>
AuthorDate: Thu Jan 7 04:14:56 2021 +0000
Automatic Site Publish by Buildbot
---
.../Community/ProcessForCppComponentReleases.html | 857 +++++++++++++++++++
.../Community/ProcessForCppComponentReleases.md | 185 ----
.../Community/ProcessForJavaComponentReleases.html | 948 +++++++++++++++++++++
.../Community/ProcessForJavaComponentReleases.md | 231 -----
4 files changed, 1805 insertions(+), 416 deletions(-)
diff --git a/output/docs/Community/ProcessForCppComponentReleases.html
b/output/docs/Community/ProcessForCppComponentReleases.html
new file mode 100644
index 0000000..406c3f5
--- /dev/null
+++ b/output/docs/Community/ProcessForCppComponentReleases.html
@@ -0,0 +1,857 @@
+<!DOCTYPE html>
+<!-- Start _layouts/doc_page.html-->
+<html lang="en">
+
+<head>
+<!-- Start _include/site_head.html -->
+<meta charset="UTF-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="description" content="">
+<meta name="author" content="datasketches">
+
+<title>DataSketches | </title>
+
+<link rel="shortcut icon" href="/img/favicon.png">
+
+<link rel="stylesheet"
href="https://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css";>
+<link rel="stylesheet"
href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css";>
+
+<link
href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600'
+ rel='stylesheet' type='text/css'>
+
+<link rel="stylesheet" href="/css/main.css">
+<link rel="stylesheet" href="/css/header.css">
+<link rel="stylesheet" href="/css/footer.css">
+<link rel="stylesheet" href="/css/syntax.css">
+<link rel="stylesheet" href="/css/docs.css">
+
+
+<script type="text/javascript"
src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full";>
+</script>
+<script src="https://code.jquery.com/jquery.min.js";></script>
+<script
src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js";></script>
+<!-- End _include/site_head.html -->
+</head>
+
+<body>
+<!-- Start _include/nav_bar.html -->
+<div class="navbar navbar-inverse navbar-static-top ds-nav">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse"
data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" style="padding-top: 0px; padding-bottom: 0px;">
+ <span class="ds-small-h-logo"></span></a>
+ </div>
+ <div class="navbar-collapse collapse">
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="/docs/Background/TheChallenge.html">
+ <span class="fa fa-info-circle"></span> DOCUMENTATION</a>
+ </li>
+ <li>
+ <a href="/docs/Community/Downloads.html">
+ <span class="fa fa-download"></span> DOWNLOAD</a>
+ </li>
+ <!--
+ <li>
+ <a href="/docs/Architecture/Components.html">
+ <span class="fa fa-github"></span> GITHUB</a>
+ </li>
+ -->
+ <li>
+ <a href="/docs/Community/Research.html">
+ <span class="fa fa-paper-plane"></span> RESEARCH</a>
+ </li>
+ <li>
+ <a href="/docs/Community/index.html" style="padding-top: 0;
padding-bottom: 0;">
+ <img class="ds-small-man"
src="/img/datasketches-ManWhite.svg"/>COMMUNITY</a>
+ </li>
+ <li>
+ <ul class="nav navbar-nav navbar-right ds-nav">
+ <li class="dropdown ds-nav" >
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown"
role="button" aria-haspopup="true" aria-expanded="false" style="padding-top: 0;
padding-bottom: 0;"><img class="apache-logo" src="/img/feather.svg"/>Apache
<span class="caret"></span></a>
+ <ul class="dropdown-menu ds-nav">
+ <li><a href="https://www.apache.org/";
target="_blank">Foundation</a></li>
+ <li><a href="https://www.apache.org/events/current-event";
target="_blank">Events</a></li>
+ <li><a href="https://www.apache.org/licenses/";
target="_blank">License</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html";
target="_blank">Thanks</a></li>
+ <li><a href="https://www.apache.org/security/";
target="_blank">Security</a></li>
+ <li><a
href="https://www.apache.org/foundation/sponsorship.html";
target="_blank">Sponsorship</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
+<!-- End _include/nav_bar.html -->
+
+<!-- Start _include/javadocs.html -->
+<div class="ds-header">
+ <div class="container">
+ <h4>API Snapshots:
+ <a href="/api/java/snapshot/apidocs/index.html">Java Core</a>,
+ <a href="/api/memory/snapshot/apidocs/index.html">Memory</a>,
+ <a href="/api/pig/snapshot/apidocs/index.html">Pig</a>,
+ <a href="/api/hive/snapshot/apidocs/index.html">Hive</a>,
+ </h4>
+ </div>
+</div>
+<!-- End _include/javadocs.html -->
+
+ <div class="container">
+ <div class="row">
+ <!-- Start ToC Block -->
+ <div class="col-md-3">
+ <div class="searchbox" style="position:relative">
+ <gcse:searchbox-only></gcse:searchbox-only>
+ </div>
+<!-- Start _includes/toc.html -->
+<!-- Computer Generated File, Do Not Edit! -->
+<link rel="stylesheet" href="/css/toc.css">
+<div id="toc" class="nav toc hidden-print">
+
+ <p id="background">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_background">Background</a>
+ </p>
+ <div class="collapse" id="collapse_background">
+ <li><a href="/docs/Background/TheChallenge.html">•The Challenge</a></li>
+ <li><a href="/docs/Background/SketchOrigins.html">•Sketch Origins</a></li>
+ <li><a href="/docs/Background/SketchElements.html">•Sketch
Elements</a></li>
+ <li><a href="/docs/Background/Presentations.html">•Presentations</a></li>
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/DataSketches_deck.pdf";>•Overview
Slide Deck</a></li>
+ </div>
+
+ <p id="architecture-and-design">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_architecture_and_design">Architecture And Design</a>
+ </p>
+ <div class="collapse" id="collapse_architecture_and_design">
+ <li><a href="/docs/Architecture/MajorSketchFamilies.html">•The Major
Sketch Families</a></li>
+ <li><a href="/docs/Architecture/LargeScale.html">•Large Scale
Computing</a></li>
+ <li><a href="/docs/Architecture/KeyFeatures.html">•Key Features</a></li>
+ <li><a href="/docs/Architecture/SketchFeaturesMatrix.html">•Sketch
Features Matrix</a></li>
+ <li><a href="/docs/Architecture/Components.html">•Components</a></li>
+ <li><a href="/docs/Architecture/SketchesByComponent.html">•Sketches by
Component</a></li>
+ <li><a href="/docs/Architecture/SketchCriteria.html">•Sketch
Criteria</a></li>
+
+ <p id="memory-package">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_memory_package">Memory Package</a>
+ </p>
+ <div class="collapse" id="collapse_memory_package">
+ <li><a href="/docs/Memory/MemoryPackage.html">•Memory Package</a></li>
+ <li><a href="/docs/Memory/MemoryPerformance.html">•Memory Package
Performance</a></li>
+ </div>
+ <li><a href="/docs/Architecture/OrderSensitivity.html">•Notes on Order
Sensitivity</a></li>
+ <li><a href="/docs/Architecture/Concurrency.html">•Notes on
Concurrency</a></li>
+ </div>
+
+ <p id="sketch-families">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_sketch_families">Sketch Families</a>
+ </p>
+ <div class="collapse" id="collapse_sketch_families">
+
+ <p id="distinct-counting">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_distinct_counting">Distinct Counting</a>
+ </p>
+ <div class="collapse" id="collapse_distinct_counting">
+ <li><a href="/docs/DistinctCountFeaturesMatrix.html">•Features
Matrix</a></li>
+ <li><a href="/docs/DistinctCountMeritComparisons.html">•Figures-of-Merit
Comparison</a></li>
+
+ <p id="cpc-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_cpc_sketches">CPC Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_cpc_sketches">
+ <li><a href="/docs/CPC/CPC.html">•CPC Sketch</a></li>
+ <li><a href="/docs/CPC/CpcPerformance.html">•CPC Sketch
Performance</a></li>
+
+ <p id="cpc-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_cpc_examples">CPC Examples</a>
+ </p>
+ <div class="collapse" id="collapse_cpc_examples">
+ <li><a href="/docs/CPC/CpcJavaExample.html">•CPC Sketch Java
Example</a></li>
+ <li><a href="/docs/CPC/CpcCppExample.html">•CPC Sketch C++
Example</a></li>
+ <li><a href="/docs/CPC/CpcPigExample.html">•CPC Sketch Pig
UDFs</a></li>
+ <li><a href="/docs/CPC/CpcHiveExample.html">•CPC Sketch Hive
UDFs</a></li>
+ </div>
+ </div>
+
+ <p id="hyperloglog-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_hyperloglog_sketches">HyperLogLog Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_hyperloglog_sketches">
+ <li><a href="/docs/HLL/HLL.html">•HLL Sketch</a></li>
+ <li><a href="/docs/HLL/HllMap.html">•HLL Map Sketch</a></li>
+
+ <p id="hll-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_hll_examples">HLL Examples</a>
+ </p>
+ <div class="collapse" id="collapse_hll_examples">
+ <li><a href="/docs/HLL/HllJavaExample.html">•HLL Sketch Java
Example</a></li>
+ <li><a href="/docs/HLL/HllCppExample.html">•HLL Sketch C++
Example</a></li>
+ <li><a href="/docs/HLL/HllPigUDFs.html">•HLL Sketch Pig UDFs</a></li>
+ <li><a href="/docs/HLL/HllHiveUDFs.html">•HLL Sketch Hive
UDFs</a></li>
+ </div>
+
+ <p id="hll-studies">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_hll_studies">HLL Studies</a>
+ </p>
+ <div class="collapse" id="collapse_hll_studies">
+ <li><a href="/docs/HLL/HllPerformance.html">•HLL Sketch
Performance</a></li>
+ <li><a href="/docs/HLL/Hll_vs_CS_Hllpp.html">•HLL vs Clearspring
HLL++</a></li>
+ <li><a
href="/docs/HLL/HllSketchVsDruidHyperLogLogCollector.html">•HLL Sketch vs Druid
HyperLogLogCollector</a></li>
+ </div>
+ </div>
+
+ <p id="theta-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_theta_sketches">Theta Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_theta_sketches">
+ <li><a href="/docs/Theta/ThetaSketchFramework.html">•Theta Sketch
Framework</a></li>
+
+ <p id="theta-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_theta_examples">Theta Examples</a>
+ </p>
+ <div class="collapse" id="collapse_theta_examples">
+ <li><a href="/docs/Theta/ConcurrentThetaSketch.html">•Concurrent
Theta Sketch</a></li>
+ <li><a href="/docs/Theta/ThetaJavaExample.html">•Theta Sketch Java
Example</a></li>
+ <li><a href="/docs/Theta/ThetaSparkExample.html">•Theta Sketch Spark
Example</a></li>
+ <li><a href="/docs/Theta/ThetaPigUDFs.html">•Theta Sketch Pig
UDFs</a></li>
+ <li><a href="/docs/Theta/ThetaHiveUDFs.html">•Theta Sketch Hive
UDFs</a></li>
+ </div>
+
+ <p id="kmv-tutorial">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_kmv_tutorial">KMV Tutorial</a>
+ </p>
+ <div class="collapse" id="collapse_kmv_tutorial">
+ <li><a href="/docs/Theta/InverseEstimate.html">•The Inverse
Estimate</a></li>
+ <li><a href="/docs/Theta/KMVempty.html">•Empty Sketch</a></li>
+ <li><a href="/docs/Theta/KMVfirstEst.html">•First Estimator</a></li>
+ <li><a href="/docs/Theta/KMVbetterEst.html">•Better
Estimator</a></li>
+ <li><a href="/docs/Theta/KMVrejection.html">•Rejection Rules</a></li>
+ <li><a href="/docs/Theta/KMVupdateVkth.html">•Update V(kth)
Rule</a></li>
+ </div>
+
+ <p id="set-operations-and-p-sampling">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_set_operations_and_p-sampling">Set Operations and P-sampling</a>
+ </p>
+ <div class="collapse" id="collapse_set_operations_and_p-sampling">
+ <li><a href="/docs/Theta/ThetaSketchSetOps.html">•Set
Operations</a></li>
+ <li><a
href="/docs/Theta/ThetaPSampling.html">•<i>p</i>-Sampling</a></li>
+ </div>
+
+ <p id="accuracy">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_accuracy">Accuracy</a>
+ </p>
+ <div class="collapse" id="collapse_accuracy">
+ <li><a href="/docs/Theta/ThetaAccuracy.html">•Basic Accuracy</a></li>
+ <li><a href="/docs/Theta/ThetaAccuracyPlots.html">•Accuracy
Plots</a></li>
+ <li><a href="/docs/Theta/ThetaErrorTable.html">•Relative Error
Table</a></li>
+ <li><a href="/docs/Theta/ThetaSketchSetOpsAccuracy.html">•SetOp
Accuracy</a></li>
+ <li><a href="/docs/Theta/AccuracyOfDifferentKUnions.html">•Unions
With Different k</a></li>
+ </div>
+
+ <p id="size">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_size">Size</a>
+ </p>
+ <div class="collapse" id="collapse_size">
+ <li><a href="/docs/Theta/ThetaSize.html">•Theta Sketch Size</a></li>
+ </div>
+
+ <p id="speed">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_speed">Speed</a>
+ </p>
+ <div class="collapse" id="collapse_speed">
+ <li><a href="/docs/Theta/ThetaUpdateSpeed.html">•Update
Speed</a></li>
+ <li><a href="/docs/Theta/ThetaMergeSpeed.html">•Merge Speed</a></li>
+ </div>
+
+ <p id="theta-sketch-theory">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_theta_sketch_theory">Theta Sketch Theory</a>
+ </p>
+ <div class="collapse" id="collapse_theta_sketch_theory">
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/ThetaSketchFramework.pdf";>•Theta
Sketch Framework (PDF)</a></li>
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/SketchEquations.pdf";>•Sketch
Equations (PDF)</a></li>
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/DataSketches.pdf";>•DataSketches
(PDF)</a></li>
+ <li><a href="/docs/Theta/ThetaConfidenceIntervals.html">•Confidence
Intervals Notes</a></li>
+ <li><a href="/docs/Theta/ThetaMergingAlgorithm.html">•Merging
Algorithm Notes</a></li>
+ <li><a href="/docs/Theta/ThetaReferences.html">•Theta
References</a></li>
+ </div>
+ </div>
+
+ <p id="tuple-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_tuple_sketches">Tuple Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_tuple_sketches">
+ <li><a href="/docs/Tuple/TupleOverview.html">•Tuple Overview</a></li>
+
+ <p id="tuple-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_tuple_examples">Tuple Examples</a>
+ </p>
+ <div class="collapse" id="collapse_tuple_examples">
+ <li><a href="/docs/Tuple/TupleJavaExample.html">•Tuple Java
Example</a></li>
+ <li><a href="/docs/Tuple/TupleEngagementExample.html">•Tuple
Engagement Example</a></li>
+ <li><a href="/docs/Tuple/TuplePigUDFs.html">•Tuple Pig UDFs</a></li>
+ <li><a href="/docs/Tuple/TupleHiveUDFs.html">•Tuple Hive
UDFs</a></li>
+ </div>
+ </div>
+ </div>
+
+ <p id="most-frequent">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_most_frequent">Most Frequent</a>
+ </p>
+ <div class="collapse" id="collapse_most_frequent">
+ <li><a href="/docs/Frequency/FrequencySketchesOverview.html">•Frequency
Sketches Overview</a></li>
+
+ <p id="frequent-item-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_frequent_item_sketches">Frequent Item Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_frequent_item_sketches">
+ <li><a href="/docs/Frequency/FrequentItemsOverview.html">•Frequent
Items Overview</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsErrorTable.html">•Frequent
Items Error Table</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsReferences.html">•Frequent
Items References</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsPerformance.html">•Frequent
Items Performance</a></li>
+
+ <p id="most-frequent-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_most_frequent_examples">Most Frequent Examples</a>
+ </p>
+ <div class="collapse" id="collapse_most_frequent_examples">
+ <li><a
href="/docs/Frequency/FrequentItemsJavaExample.html">•Frequent Items Java
Example</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsCppExample.html">•Frequent
Items C++ Example</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsPigUDFs.html">•Frequent
Items Pig UDFs</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsHiveUDFs.html">•Frequent
Items Hive UDFs</a></li>
+ </div>
+ </div>
+
+ <p id="frequent-distinct-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_frequent_distinct_sketches">Frequent Distinct Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_frequent_distinct_sketches">
+ <li><a
href="/docs/Frequency/FrequentDistinctTuplesSketch.html">•Frequent Distinct
Tuples Sketch</a></li>
+ </div>
+ </div>
+
+ <p id="quantiles-and-histograms">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_and_histograms">Quantiles And Histograms</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_and_histograms">
+ <li><a href="/docs/Quantiles/QuantilesOverview.html">•Quantiles
Overview</a></li>
+ <li><a href="/docs/Quantiles/QuantilesAccuracy.html">•Quantiles Accuracy
and Size</a></li>
+
+ <p id="quantiles-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_examples">Quantiles Examples</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_examples">
+ <li><a href="/docs/Quantiles/QuantilesJavaExample.html">•Quantiles
Sketch Java Example</a></li>
+ <li><a href="/docs/Quantiles/QuantilesCppExample.html">•KLL Quantiles
Sketch C++ Example</a></li>
+ <li><a href="/docs/Quantiles/QuantilesPigUDFs.html">•Quantiles Sketch
Pig UDFs</a></li>
+ <li><a href="/docs/Quantiles/QuantilesHiveUDFs.html">•Quantiles Sketch
Hive UDFs</a></li>
+ </div>
+
+ <p id="quantiles-studies">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_studies">Quantiles Studies</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_studies">
+ <li><a href="/docs/Quantiles/Definitions.html">•Definitions for
Quantiles Studies</a></li>
+ <li><a href="/docs/Quantiles/KLLSketch.html">•New KLL sketch and
comparison with DoublesSketch</a></li>
+ <li><a href="/docs/Quantiles/KllSketchVsTDigest.html">•KLL sketch vs
t-digest</a></li>
+ <li><a href="/docs/Quantiles/DruidApproxHistogramStudy.html">•Druid
Approximate Histogram</a></li>
+ <li><a href="/docs/Quantiles/MomentsSketchStudy.html">•Moments Sketch
Study</a></li>
+ <li><a href="/docs/Quantiles/QuantilesStreamAStudy.html">•Quantiles
StreamA Study</a></li>
+ <li><a href="/docs/Quantiles/ExactQuantiles.html">•Exact Quantiles for
Studies</a></li>
+ </div>
+
+ <p id="quantiles-sketch-theory">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_sketch_theory">Quantiles Sketch Theory</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_sketch_theory">
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/Quantiles_KLL.pdf";>•Optimal
Quantile Approximation in Streams</a></li>
+ <li><a href="/docs/Quantiles/QuantilesReferences.html">•Quantiles
References</a></li>
+ </div>
+ </div>
+
+ <p id="sampling">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_sampling">Sampling</a>
+ </p>
+ <div class="collapse" id="collapse_sampling">
+ <li><a href="/docs/Sampling/ReservoirSampling.html">•Reservoir
Sampling</a></li>
+ <li><a
href="/docs/Sampling/ReservoirSamplingPerformance.html">•Reservoir Sampling
Performance</a></li>
+ <li><a href="/docs/Sampling/VarOptSampling.html">•VarOpt
Sampling</a></li>
+
+ <p id="sampling-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_sampling_examples">Sampling Examples</a>
+ </p>
+ <div class="collapse" id="collapse_sampling_examples">
+ <li><a href="/docs/Sampling/ReservoirSamplingJava.html">•Reservoir
Sampling Java Example</a></li>
+ <li><a href="/docs/Sampling/ReservoirSamplingPigUDFs.html">•Reservoir
Sampling Pig UDFs</a></li>
+ <li><a href="/docs/Sampling/VarOptSamplingJava.html">•VarOpt Sampling
Java Example</a></li>
+ <li><a href="/docs/Sampling/VarOptPigUDFs.html">•VarOpt Sampling Pig
UDFs</a></li>
+ </div>
+ </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="/docs/SystemIntegrations/ApacheDruidIntegration.html">•Using
Sketches in ApacheDruid</a></li>
+ <li><a href="/docs/SystemIntegrations/ApacheHiveIntegration.html">•Using
Sketches in Apache Hive</a></li>
+ <li><a href="/docs/SystemIntegrations/ApachePigIntegration.html">•Using
Sketches in Apache Pig</a></li>
+ <li><a href="/docs/SystemIntegrations/PostgreSQLIntegration.html">•Using
Sketches in PostgreSQL</a></li>
+ </div>
+
+ <p id="community">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_community">Community</a>
+ </p>
+ <div class="collapse" id="collapse_community">
+ <li><a href="/docs/Community/index.html">•Community</a></li>
+ <li><a href="/docs/Community/Downloads.html">•Downloads</a></li>
+ <li><a href="/docs/Community/NewCommitterProcess.html">•New Committer
Process</a></li>
+ <li><a href="/docs/Community/ProcessForCppComponentReleases.html">•Process
For CPP Component Releases</a></li>
+ <li><a
href="/docs/Community/ProcessForJavaComponentReleases.html">•Process For Java
Component Releases</a></li>
+ <li><a href="/docs/Community/Transitioning.html">•Transitioning from prior
GitHub Site</a></li>
+ <li><a href="/docs/Community/WhoUses.html">•Who Uses</a></li>
+ </div>
+
+ <p id="research">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_research">Research</a>
+ </p>
+ <div class="collapse" id="collapse_research">
+ <li><a href="/docs/Community/Research.html">•Research</a></li>
+ </div>
+</div>
+<!-- End _includes/toc.html -->
+
+
+<!-- Start _includes/tocScript.html -->
+<script>
+ (function () {
+
+ var findLineItem = function (path) {
+ return document.querySelector(`#toc [href="${path}"]`);
+ };
+
+ function findNavItem(path) {
+ return document.querySelector(`.nav [href="${path}"]`);
+ }
+
+ var highlighLineItem = function (element) {
+ element.classList.add('highlight');
+ };
+
+ var checkHasClass = function (element, className) {
+ return element.className.split(' ').find(function (item) { return item
=== className || '' })
+ }
+
+ var findAllCollapseParents = function (element) {
+ var collapseMenus = [];
+ var elementPointer = element;
+ while (elementPointer !== document.body) {
+ if (checkHasClass(elementPointer, 'collapse')) {
+ collapseMenus.push(elementPointer);
+ }
+ elementPointer = elementPointer.parentElement
+ }
+ return collapseMenus
+ };
+
+ var openMenuItem = function (element) {
+ // $(element).collapse('show') would start a transition, adding `in`
class instead.
+ element.classList.add('in');
+ };
+
+ var openAllFromList = function (elementList) {
+ elementList.forEach(openMenuItem);
+ };
+
+ var highlightAndOpenMenu = function () {
+ // Highlight & expand nav item in the TOC
+ var currentLineItem = findLineItem(document.location.pathname);
+ highlighLineItem(currentLineItem);
+ openAllFromList(findAllCollapseParents(currentLineItem));
+
+ // Highlight nav item in top navigation
+ highlighLineItem(findNavItem(document.location.pathname));
+ };
+
+ $(highlightAndOpenMenu);
+
+ }());
+</script>
+<!-- End _includes/tocScript.html -->
+
+ </div>
+ <!-- End ToC Block -->
+ <div class="col-md-9 doc-content">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<h1 id="apache-c-release-steps">Apache C++ Release Steps</h1>
+<p><strong>NOTES:</strong></p>
+
+<ul>
+ <li>This process covers major and minor releases only. Bug-fix releases,
which increment the third digit, are performed on a A.B.X branch and not on
master, but otherwise is similar.</li>
+ <li>Some of these operations can be performed either on the Command-Line or
in your IDE, whatever you prefer.</li>
+</ul>
+
+<h2 id="preparation">Preparation</h2>
+<ul>
+ <li>Confirm correctness for
+ <ul>
+ <li>LICENSE</li>
+ <li>NOTICE – check for copyright dates</li>
+ <li>README.md</li>
+ <li>.gitignore</li>
+ <li>DISCLAIMER-WIP</li>
+ </ul>
+ </li>
+ <li>From Command Line or IDE:
+ <ul>
+ <li>Run Unit tests</li>
+ <li>Run Code Coverage > 90%</li>
+ <li>Confirm that all <strong>temporary</strong> branches are checked
into master and/or deleted, both local and remote.</li>
+ <li>Confirm any new bug fixes have corresponding tests</li>
+ </ul>
+ </li>
+ <li>From Command Line at Component root:
+ <ul>
+ <li>Confirm GPG is running (check this every time you open a new
Terminal):
+ <ul>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>$ env</td>
+ <td>grep GPG # you should see something like:
GPG_TTY=/dev/ttys000</td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+ <li>To start GPG if GPG Agent is not running:
+ <ul>
+ <li>$ eval $(gpg-agent –daemon)</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>Confirm GitHub repository is current and git status is clean:
+ <ul>
+ <li>$ git status
+ <ul>
+ <li>“nothing to commit, working tree clean”</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>At major version releases, search for deprecated code and remove at
<strong>Major Versions</strong> only.
+ <ul>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>$ find . -name “*.?pp” -type f -print</td>
+ <td>xargs grep -i -n -s -A0 “deprecated”</td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+ <li>may need to ignore false positives in the pybind11 directory</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create-permanent-release-branch--python-version-preparation">Create
Permanent Release Branch & Python Version Preparation</h2>
+<ul>
+ <li>Assume target version = A.B.0</li>
+ <li>From IDE or Command Line:
+ <ul>
+ <li>Switch from master to new <strong>Permanent Branch</strong>:
“A.B.X”</li>
+ <li>Check setup.py “version=” line to A.B.X (remove -SNAPSHOT, do not
change A or B)</li>
+ <li>Commit the change. <strong>DO NOT PUSH!</strong></li>
+ <li>Create Annotated TAG: A.B.0-RC1 (or RCn)</li>
+ <li>Write down the Git hash : example: 40c6f4f</li>
+ <li>Now Push Branch “A.B.X” with edited setup.py to origin</li>
+ <li><strong>DO NOT MERGE THIS PERMANENT BRANCH INTO MASTER</strong></li>
+ </ul>
+ </li>
+ <li>From IDE or Command-line:
+ <ul>
+ <li>Do explicit push of tags on branch “A.B.X” to origin:
+ <ul>
+ <li>$ git push origin –tags</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>From a web browser at origin web site:
github.com/apache/datasketches-<component>
+ <ul>
+ <li>Select the A.B.X branch</li>
+ <li>Confirm that the tag: A.B.0-RC1 exists and that the tag is on the
latest commit and with the correct Git hash.</li>
+ <li><strong>DO NOT CREATE PR OR MERGE THIS PERMANENT BRANCH INTO
MASTER</strong></li>
+ </ul>
+ </li>
+ <li>From IDE or Command Line:
+ <ul>
+ <li>Confirm that the tag A.B.0-RC1 and the branch A.B.X, and HEAD
coincide with the correct Git hash.</li>
+ <li>Confirm that there are no unstaged or staged changes.</li>
+ <li>Return to master branch</li>
+ <li>Edit master setup.py to A’.B’.0-SNAPSHOT where A’ or B’ will be
incremented by 1. (Bug fix releases will change the 3rd digit)</li>
+ <li>Commit and Push this change to origin/master with the comment
“Release Process: Change setup.py version to A’.B’.0-SNAPSHOT.”</li>
+ <li>Return to release branch A.B.X</li>
+ <li>You may minimize your IDE, pointing at the release branch.</li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create-andor-checkout-local-distdev-directories-on-your-system">Create
and/or Checkout Local <em>dist/dev</em> directories on your system</h2>
+<ul>
+ <li>If you have not already, on your system create the two directory
structures that mirror the dist.apache.org/repos/ directories:
+ <ul>
+ <li>mkdir dist/dev/datasketches/</li>
+ <li>mkdir dist/release/datasketches/</li>
+ </ul>
+ </li>
+ <li>Checkout both “dev” and “release” directories
+ <ul>
+ <li>Open a terminal in the dist/dev/datasketches directory and do a
checkout:
+ <ul>
+ <li>svn co https://dist.apache.org/repos/dist/dev/datasketches/ .
#Note the DOT</li>
+ <li>svn status # make sure it is clean</li>
+ </ul>
+ </li>
+ <li>Open a terminal in the dist/release/datasketches directory and do a
checkout:
+ <ul>
+ <li>svn co https://dist.apache.org/repos/dist/release/datasketches/
. #Note the DOT</li>
+ <li>svn status # make sure it is clean</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create-the-candidate-apache-release-distribution-on-distdev">Create
the Candidate Apache Release Distribution on <em>dist/dev</em></h2>
+<h3 id="create-primary-zip-files--signatures">Create primary zip files &
signatures</h3>
+<ul>
+ <li>You will need the following arguments:
+ <ul>
+ <li>Absolute path of target project.basedir on your system</li>
+ <li>Artifact name : datasketches-<component> where component is
e.g., cpp</li>
+ <li>GitHub Tag: A.B.0-RC1 (or RCn)</li>
+ </ul>
+ </li>
+ <li>Start a new terminal in the above dist/dev/datasketches/scripts
directory on your system:
+ <ul>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>Confirm GPG is running: $ env</td>
+ <td>grep GPG</td>
+ </tr>
+ </tbody>
+ </table>
+ <ul>
+ <li>If not: $ eval $(gpg-agent –daemon)</li>
+ </ul>
+ </li>
+ <li>Run something like:
+ <ul>
+ <li>$ ./bashDeployToDist.sh
/Users/<name>/dev/git/Apache/datasketches-<component>
datasketches-<component> A.B.0-RC1</li>
+ <li>Follow the instructions.</li>
+ <li>NOTE: if you get the error “gpg: signing failed: No pinentry”:
+ <ul>
+ <li>open .gnupg/gpg-agent.conf</li>
+ <li>change to: pinentry-program /usr/local/bin/pinentry-tty</li>
+ <li>reload the gpg agent in the terminal: gpg-connect-agent
reloadagent /bye</li>
+ <li>restart the ./bashDeployToDist script</li>
+ </ul>
+ </li>
+ <li>Close the terminal</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>Check and grab the web URL ~
https://dist.apache.org/repos/dist/dev/datasketches/<component>/A.B.0-RC1/
+ <ul>
+ <li>There should be 3 files: *-src.zip, *-src.zip.asc,
*-src.zip.sha512</li>
+ </ul>
+ </li>
+</ul>
+
+<h3 id="create-copy-of-external-artifact-distributions">Create Copy of
External Artifact Distributions</h3>
+<ul>
+ <li>For Java, we need to place copies of the artifact jars deployed to Nexus
under a “maven” directory.</li>
+ <li>For external artifacts of Python or Docker it will be something
else.</li>
+ <li>For example see <a
href="https://dist.apache.org/repos/dist/release/datasketches/java/1.3.0-incubating/";>https://dist.apache.org/repos/dist/release/datasketches/java/1.3.0-incubating/</a></li>
+ <li>These must be signed with GPG (.asc) and SHA512 (.sha512)</li>
+ <li>I will create a script for these artifacts someday :)</li>
+</ul>
+
+<h2 id="prepare--send-vote-letter-to-dev">Prepare & Send [VOTE] Letter to
dev@</h2>
+<ul>
+ <li>See VoteTemplates directory for a recent example</li>
+ <li>If vote is not successful, fix the problem and repeat above steps.</li>
+ <li>After a successful vote return to <strong>this point</strong> and
continue …</li>
+</ul>
+
+<h2 id="prepare--send-vote-result-letter-to-dev">Prepare & Send
[VOTE-RESULT] Letter to dev@</h2>
+<ul>
+ <li>See VoteTemplates directory for a recent example</li>
+ <li>Declare that the vote is closed.</li>
+ <li>Summarize PPMC vote results</li>
+</ul>
+
+<h2 id="move-files-from-devstaging-to-release">Move files from dev/staging to
release</h2>
+<h3 id="move-primary-zip-files-from-distdev-to-distrelease">Move primary zip
files from <em>dist/dev</em> to <em>dist/release</em></h3>
+<ul>
+ <li>In local dist/<strong>dev</strong>/datasketches/
+ <ul>
+ <li>Open Terminal #1
+ <ul>
+ <li>Perform SVN Checkout:
+ <ul>
+ <li>$ svn co
https://dist.apache.org/repos/dist/dev/datasketches/ . #note dot at end</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>In local dist/<strong>release</strong>/datasketches/
+ <ul>
+ <li>Open Terminal #2
+ <ul>
+ <li>Perform SVN Checkout:
+ <ul>
+ <li>$ svn co
https://dist.apache.org/repos/dist/release/datasketches/ . #note dot at end</li>
+ </ul>
+ </li>
+ <li>Create new version directory under appropriate component
directory:
+ <ul>
+ <li>$ mkdir -p <component>/A.B.0</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>Using local file system copy files
+ <ul>
+ <li>From …
/dist/dev/datasketches/<component>/version-RCnn/*</li>
+ <li>To … /dist/release/datasketches/<component>/version (no
RCnn)/*</li>
+ </ul>
+ </li>
+ <li>Using Terminal #2 at … /dist/release/datasketches directory:
+ <ul>
+ <li>svn add . –force</li>
+ <li>svn ci -m “Release A.B.0”</li>
+ <li>Remove the prior release…</li>
+ <li>svn remove <component>/X.Y.0</li>
+ <li>svn ci -m “Remove Prior release”</li>
+ <li>svn status # should be empty</li>
+ </ul>
+ </li>
+ <li>Using local file system
+ <ul>
+ <li>Delete the prior X.Y.0 directory</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h3 id="move-external-artifact-distributions-distdev-to-distrelease">Move
External Artifact Distributions <em>dist/dev</em> to <em>dist/release</em></h3>
+
+<h2 id="create--document-release-tag-on-github">Create & Document Release
Tag on GitHub</h2>
+<ul>
+ <li>Open your IDE and switch to the recently created Release Branch
A.B.X</li>
+ <li>Find the recently created A.B.0-RCn tag in that branch</li>
+ <li>At that same GitHub ID hash, create a new tag A.B.0 (without the
RCn).</li>
+ <li>From the Command Line: Push the new tag to origin:
+ <ul>
+ <li>$ git push origin –tags</li>
+ </ul>
+ </li>
+ <li>On the GitHub component site document the release</li>
+</ul>
+
+<h2 id="update-website-downloadsmd-latest-source-zip-files-table">Update
Website Downloads.md “Latest Source Zip Files” Table</h2>
+<ul>
+ <li>This script assumes that the remote …/dist/release/datasketches/…
directories are up-to-date with no old releases.</li>
+ <li>Start a new terminal in the ../dist/dev/datasketches/scripts directory
on your system:</li>
+ <li>Make sure you local website directory is pointing to master and
up-to-date.</li>
+ <li>Run the following with the argument specifying the location of your
local website directory:
+ <ul>
+ <li>$ ./createDownloadsInclude.sh /Users/<name>/ …
/datasketches-website</li>
+ </ul>
+ </li>
+ <li>When this is done, be sure to commit the changes to the website.</li>
+</ul>
+
+<h2 id="update-javadocs-or-equivalent-on-website">Update Javadocs (or
Equivalent) on Website</h2>
+
+<h2 id="update-website-documentation-if-new-functionality">Update Website
Documentation (if new functionality)</h2>
+
+<h2 id="prepare-announce-letter-to-dev">Prepare Announce Letter to dev@</h2>
+<ul>
+ <li>ASF requests that you wait 24 hours to publish Announce letter to allow
the propagation to mirrors.</li>
+ <li>Use recent template</li>
+ <li>Summarize vote results</li>
+</ul>
+
+<h2 id="update-these-instructions">Update These Instructions</h2>
+<ul>
+ <li>If you have updated this file or any of the scripts, please check it in
using SVN using your local dist/dev directory copy:
+ <ul>
+ <li>$ svn status</li>
+ <li>$ svn add . –force # if adding a file for the first time</li>
+ <li>$ svn ci -m “update Release Steps”</li>
+ </ul>
+ </li>
+</ul>
+
+ </div> <!-- End content -->
+ </div> <!-- End row -->
+ </div> <!-- End Container -->
+
+<!-- Start _include/page_footer.html -->
+<footer class="ds-footer">
+ <div class="container">
+ <div class="text-center">
+ <p>
+ <div>Copyright © 2020 <a href="https://www.apache.org";>Apache Software
Foundation</a>,
+ Licensed under the Apache License, Version 2.0. All Rights
Reserved.<br/>
+ Apache DataSketches, Apache, the Apache feather logo, and the Apache
DataSketches project logos are trademarks of The Apache Software
Foundation.<br/>
+ All other marks mentioned may be trademarks or registered trademarks
of their respective owners.
+ </div>
+ </p>
+ </div>
+ </div>
+</footer>
+<!-- End _include/page_footer.html -->
+
+</body>
+
+</html>
+<!-- End _layouts/doc_page.html-->
\ No newline at end of file
diff --git a/output/docs/Community/ProcessForCppComponentReleases.md
b/output/docs/Community/ProcessForCppComponentReleases.md
deleted file mode 100644
index ef2ced2..0000000
--- a/output/docs/Community/ProcessForCppComponentReleases.md
+++ /dev/null
@@ -1,185 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-# Apache C++ Release Steps
-__NOTES:__
-
-* This process covers major and minor releases only. Bug-fix releases, which
increment the third digit, are performed on a A.B.X branch and not on master,
but otherwise is similar.
-* Some of these operations can be performed either on the Command-Line or in
your IDE, whatever you prefer.
-
-## Preparation
-* Confirm correctness for
- * LICENSE
- * NOTICE -- check for copyright dates
- * README.md
- * .gitignore
- * DISCLAIMER-WIP
-
-* From Command Line or IDE:
- * Run Unit tests
- * Run Code Coverage > 90%
- * Confirm that all __temporary__ branches are checked into master and/or
deleted, both local and remote.
- * Confirm any new bug fixes have corresponding tests
-
-* From Command Line at Component root:
- * Confirm GPG is running (check this every time you open a new Terminal):
- * $ env | grep GPG # you should see something like: GPG_TTY=/dev/ttys000
- * To start GPG if GPG Agent is not running:
- * $ eval $(gpg-agent --daemon)
- * Confirm GitHub repository is current and git status is clean:
- * $ git status
- * "nothing to commit, working tree clean"
- * At major version releases, search for deprecated code and remove at
__Major Versions__ only.
- * $ find . -name "*.?pp" -type f -print | xargs grep -i -n -s -A0
"deprecated"
- * may need to ignore false positives in the pybind11 directory
-
-
-## Create Permanent Release Branch & Python Version Preparation
-* Assume target version = A.B.0
-* From IDE or Command Line:
- * Switch from master to new __Permanent Branch__: "A.B.X"
- * Check setup.py "version=" line to A.B.X (remove -SNAPSHOT, do not change
A or B)
- * Commit the change. __DO NOT PUSH!__
- * Create Annotated TAG: A.B.0-RC1 (or RCn)
- * Write down the Git hash : example: 40c6f4f
- * Now Push Branch "A.B.X" with edited setup.py to origin
- * __DO NOT MERGE THIS PERMANENT BRANCH INTO MASTER__
-* From IDE or Command-line:
- * Do explicit push of tags on branch "A.B.X" to origin:
- * $ git push origin --tags
-* From a web browser at origin web site:
github.com/apache/datasketches-\<component\>
- * Select the A.B.X branch
- * Confirm that the tag: A.B.0-RC1 exists and that the tag is on the latest
commit and with the correct Git hash.
- * __DO NOT CREATE PR OR MERGE THIS PERMANENT BRANCH INTO MASTER__
-* From IDE or Command Line:
- * Confirm that the tag A.B.0-RC1 and the branch A.B.X, and HEAD coincide
with the correct Git hash.
- * Confirm that there are no unstaged or staged changes.
- * Return to master branch
- * Edit master setup.py to A'.B'.0-SNAPSHOT where A' or B' will be
incremented by 1. (Bug fix releases will change the 3rd digit)
- * Commit and Push this change to origin/master with the comment "Release
Process: Change setup.py version to A'.B'.0-SNAPSHOT."
- * Return to release branch A.B.X
- * You may minimize your IDE, pointing at the release branch.
-
-## Create and/or Checkout Local *dist/dev* directories on your system
-* If you have not already, on your system create the two directory structures
that mirror the dist.apache.org/repos/ directories:
- * mkdir dist/dev/datasketches/
- * mkdir dist/release/datasketches/
-* Checkout both "dev" and "release" directories
- * Open a terminal in the dist/dev/datasketches directory and do a checkout:
- * svn co https://dist.apache.org/repos/dist/dev/datasketches/ .
#Note the DOT
- * svn status # make sure it is clean
- * Open a terminal in the dist/release/datasketches directory and do a
checkout:
- * svn co https://dist.apache.org/repos/dist/release/datasketches/ .
#Note the DOT
- * svn status # make sure it is clean
-
-## Create the Candidate Apache Release Distribution on *dist/dev*
-### Create primary zip files & signatures
-* You will need the following arguments:
- * Absolute path of target project.basedir on your system
- * Artifact name : datasketches-\<component\> where component is e.g., cpp
- * GitHub Tag: A.B.0-RC1 (or RCn)
-* Start a new terminal in the above dist/dev/datasketches/scripts directory on
your system:
- * Confirm GPG is running: $ env | grep GPG
- * If not: $ eval $(gpg-agent --daemon)
- * Run something like:
- * $ ./bashDeployToDist.sh
/Users/\<name\>/dev/git/Apache/datasketches-\<component\>
datasketches-\<component\> A.B.0-RC1
- * Follow the instructions.
- * NOTE: if you get the error "gpg: signing failed: No pinentry":
- * open .gnupg/gpg-agent.conf
- * change to: pinentry-program /usr/local/bin/pinentry-tty
- * reload the gpg agent in the terminal: gpg-connect-agent reloadagent
/bye
- * restart the ./bashDeployToDist script
- * Close the terminal
-* Check and grab the web URL ~
https://dist.apache.org/repos/dist/dev/datasketches/\<component\>/A.B.0-RC1/
- * There should be 3 files: \*-src.zip, \*-src.zip.asc, \*-src.zip.sha512
-
-### Create Copy of External Artifact Distributions
-* For Java, we need to place copies of the artifact jars deployed to Nexus
under a "maven" directory.
-* For external artifacts of Python or Docker it will be something else.
-* For example see
<https://dist.apache.org/repos/dist/release/datasketches/java/1.3.0-incubating/>
-* These must be signed with GPG (.asc) and SHA512 (.sha512)
-* I will create a script for these artifacts someday :)
-
-## Prepare & Send [VOTE] Letter to dev@
-* See VoteTemplates directory for a recent example
-* If vote is not successful, fix the problem and repeat above steps.
-* After a successful vote return to __this point__ and continue ...
-
-## Prepare & Send [VOTE-RESULT] Letter to dev@
-* See VoteTemplates directory for a recent example
-* Declare that the vote is closed.
-* Summarize PPMC vote results
-
-## Move files from dev/staging to release
-### Move primary zip files from *dist/dev* to *dist/release*
-* In local dist/__dev__/datasketches/
- * Open Terminal #1
- * Perform SVN Checkout:
- * $ svn co https://dist.apache.org/repos/dist/dev/datasketches/ .
#note dot at end
-* In local dist/__release__/datasketches/
- * Open Terminal #2
- * Perform SVN Checkout:
- * $ svn co
https://dist.apache.org/repos/dist/release/datasketches/ . #note dot at end
- * Create new version directory under appropriate component directory:
- * $ mkdir -p \<component\>/A.B.0
- * Using local file system copy files
- * From ... /dist/dev/datasketches/\<component\>/version-RCnn/*
- * To ... /dist/release/datasketches/\<component\>/version (no
RCnn)/*
- * Using Terminal #2 at ... /dist/release/datasketches directory:
- * svn add . --force
- * svn ci -m "Release A.B.0"
- * Remove the prior release...
- * svn remove \<component\>/X.Y.0
- * svn ci -m "Remove Prior release"
- * svn status # should be empty
- * Using local file system
- * Delete the prior X.Y.0 directory
-
-### Move External Artifact Distributions *dist/dev* to *dist/release*
-
-## Create & Document Release Tag on GitHub
-* Open your IDE and switch to the recently created Release Branch A.B.X
-* Find the recently created A.B.0-RCn tag in that branch
-* At that same GitHub ID hash, create a new tag A.B.0 (without the RCn).
-* From the Command Line: Push the new tag to origin:
- * $ git push origin --tags
-* On the GitHub component site document the release
-
-## Update Website Downloads.md "Latest Source Zip Files" Table
-* This script assumes that the remote .../dist/release/datasketches/...
directories are up-to-date with no old releases.
-* Start a new terminal in the ../dist/dev/datasketches/scripts directory on
your system:
-* Make sure you local website directory is pointing to master and up-to-date.
-* Run the following with the argument specifying the location of your local
website directory:
- * $ ./createDownloadsInclude.sh /Users/\<name\>/ ... /datasketches-website
-* When this is done, be sure to commit the changes to the website.
-
-## Update Javadocs (or Equivalent) on Website
-
-## Update Website Documentation (if new functionality)
-
-## Prepare Announce Letter to dev@
-* ASF requests that you wait 24 hours to publish Announce letter to allow the
propagation to mirrors.
-* Use recent template
-* Summarize vote results
-
-## Update These Instructions
-* If you have updated this file or any of the scripts, please check it in
using SVN using your local dist/dev directory copy:
- * $ svn status
- * $ svn add . --force # if adding a file for the first time
- * $ svn ci -m "update Release Steps"
diff --git a/output/docs/Community/ProcessForJavaComponentReleases.html
b/output/docs/Community/ProcessForJavaComponentReleases.html
new file mode 100644
index 0000000..261a1b0
--- /dev/null
+++ b/output/docs/Community/ProcessForJavaComponentReleases.html
@@ -0,0 +1,948 @@
+<!DOCTYPE html>
+<!-- Start _layouts/doc_page.html-->
+<html lang="en">
+
+<head>
+<!-- Start _include/site_head.html -->
+<meta charset="UTF-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="description" content="">
+<meta name="author" content="datasketches">
+
+<title>DataSketches | </title>
+
+<link rel="shortcut icon" href="/img/favicon.png">
+
+<link rel="stylesheet"
href="https://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css";>
+<link rel="stylesheet"
href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css";>
+
+<link
href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600'
+ rel='stylesheet' type='text/css'>
+
+<link rel="stylesheet" href="/css/main.css">
+<link rel="stylesheet" href="/css/header.css">
+<link rel="stylesheet" href="/css/footer.css">
+<link rel="stylesheet" href="/css/syntax.css">
+<link rel="stylesheet" href="/css/docs.css">
+
+
+<script type="text/javascript"
src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full";>
+</script>
+<script src="https://code.jquery.com/jquery.min.js";></script>
+<script
src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js";></script>
+<!-- End _include/site_head.html -->
+</head>
+
+<body>
+<!-- Start _include/nav_bar.html -->
+<div class="navbar navbar-inverse navbar-static-top ds-nav">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse"
data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" style="padding-top: 0px; padding-bottom: 0px;">
+ <span class="ds-small-h-logo"></span></a>
+ </div>
+ <div class="navbar-collapse collapse">
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="/docs/Background/TheChallenge.html">
+ <span class="fa fa-info-circle"></span> DOCUMENTATION</a>
+ </li>
+ <li>
+ <a href="/docs/Community/Downloads.html">
+ <span class="fa fa-download"></span> DOWNLOAD</a>
+ </li>
+ <!--
+ <li>
+ <a href="/docs/Architecture/Components.html">
+ <span class="fa fa-github"></span> GITHUB</a>
+ </li>
+ -->
+ <li>
+ <a href="/docs/Community/Research.html">
+ <span class="fa fa-paper-plane"></span> RESEARCH</a>
+ </li>
+ <li>
+ <a href="/docs/Community/index.html" style="padding-top: 0;
padding-bottom: 0;">
+ <img class="ds-small-man"
src="/img/datasketches-ManWhite.svg"/>COMMUNITY</a>
+ </li>
+ <li>
+ <ul class="nav navbar-nav navbar-right ds-nav">
+ <li class="dropdown ds-nav" >
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown"
role="button" aria-haspopup="true" aria-expanded="false" style="padding-top: 0;
padding-bottom: 0;"><img class="apache-logo" src="/img/feather.svg"/>Apache
<span class="caret"></span></a>
+ <ul class="dropdown-menu ds-nav">
+ <li><a href="https://www.apache.org/";
target="_blank">Foundation</a></li>
+ <li><a href="https://www.apache.org/events/current-event";
target="_blank">Events</a></li>
+ <li><a href="https://www.apache.org/licenses/";
target="_blank">License</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html";
target="_blank">Thanks</a></li>
+ <li><a href="https://www.apache.org/security/";
target="_blank">Security</a></li>
+ <li><a
href="https://www.apache.org/foundation/sponsorship.html";
target="_blank">Sponsorship</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
+<!-- End _include/nav_bar.html -->
+
+<!-- Start _include/javadocs.html -->
+<div class="ds-header">
+ <div class="container">
+ <h4>API Snapshots:
+ <a href="/api/java/snapshot/apidocs/index.html">Java Core</a>,
+ <a href="/api/memory/snapshot/apidocs/index.html">Memory</a>,
+ <a href="/api/pig/snapshot/apidocs/index.html">Pig</a>,
+ <a href="/api/hive/snapshot/apidocs/index.html">Hive</a>,
+ </h4>
+ </div>
+</div>
+<!-- End _include/javadocs.html -->
+
+ <div class="container">
+ <div class="row">
+ <!-- Start ToC Block -->
+ <div class="col-md-3">
+ <div class="searchbox" style="position:relative">
+ <gcse:searchbox-only></gcse:searchbox-only>
+ </div>
+<!-- Start _includes/toc.html -->
+<!-- Computer Generated File, Do Not Edit! -->
+<link rel="stylesheet" href="/css/toc.css">
+<div id="toc" class="nav toc hidden-print">
+
+ <p id="background">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_background">Background</a>
+ </p>
+ <div class="collapse" id="collapse_background">
+ <li><a href="/docs/Background/TheChallenge.html">•The Challenge</a></li>
+ <li><a href="/docs/Background/SketchOrigins.html">•Sketch Origins</a></li>
+ <li><a href="/docs/Background/SketchElements.html">•Sketch
Elements</a></li>
+ <li><a href="/docs/Background/Presentations.html">•Presentations</a></li>
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/DataSketches_deck.pdf";>•Overview
Slide Deck</a></li>
+ </div>
+
+ <p id="architecture-and-design">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_architecture_and_design">Architecture And Design</a>
+ </p>
+ <div class="collapse" id="collapse_architecture_and_design">
+ <li><a href="/docs/Architecture/MajorSketchFamilies.html">•The Major
Sketch Families</a></li>
+ <li><a href="/docs/Architecture/LargeScale.html">•Large Scale
Computing</a></li>
+ <li><a href="/docs/Architecture/KeyFeatures.html">•Key Features</a></li>
+ <li><a href="/docs/Architecture/SketchFeaturesMatrix.html">•Sketch
Features Matrix</a></li>
+ <li><a href="/docs/Architecture/Components.html">•Components</a></li>
+ <li><a href="/docs/Architecture/SketchesByComponent.html">•Sketches by
Component</a></li>
+ <li><a href="/docs/Architecture/SketchCriteria.html">•Sketch
Criteria</a></li>
+
+ <p id="memory-package">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_memory_package">Memory Package</a>
+ </p>
+ <div class="collapse" id="collapse_memory_package">
+ <li><a href="/docs/Memory/MemoryPackage.html">•Memory Package</a></li>
+ <li><a href="/docs/Memory/MemoryPerformance.html">•Memory Package
Performance</a></li>
+ </div>
+ <li><a href="/docs/Architecture/OrderSensitivity.html">•Notes on Order
Sensitivity</a></li>
+ <li><a href="/docs/Architecture/Concurrency.html">•Notes on
Concurrency</a></li>
+ </div>
+
+ <p id="sketch-families">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_sketch_families">Sketch Families</a>
+ </p>
+ <div class="collapse" id="collapse_sketch_families">
+
+ <p id="distinct-counting">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_distinct_counting">Distinct Counting</a>
+ </p>
+ <div class="collapse" id="collapse_distinct_counting">
+ <li><a href="/docs/DistinctCountFeaturesMatrix.html">•Features
Matrix</a></li>
+ <li><a href="/docs/DistinctCountMeritComparisons.html">•Figures-of-Merit
Comparison</a></li>
+
+ <p id="cpc-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_cpc_sketches">CPC Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_cpc_sketches">
+ <li><a href="/docs/CPC/CPC.html">•CPC Sketch</a></li>
+ <li><a href="/docs/CPC/CpcPerformance.html">•CPC Sketch
Performance</a></li>
+
+ <p id="cpc-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_cpc_examples">CPC Examples</a>
+ </p>
+ <div class="collapse" id="collapse_cpc_examples">
+ <li><a href="/docs/CPC/CpcJavaExample.html">•CPC Sketch Java
Example</a></li>
+ <li><a href="/docs/CPC/CpcCppExample.html">•CPC Sketch C++
Example</a></li>
+ <li><a href="/docs/CPC/CpcPigExample.html">•CPC Sketch Pig
UDFs</a></li>
+ <li><a href="/docs/CPC/CpcHiveExample.html">•CPC Sketch Hive
UDFs</a></li>
+ </div>
+ </div>
+
+ <p id="hyperloglog-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_hyperloglog_sketches">HyperLogLog Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_hyperloglog_sketches">
+ <li><a href="/docs/HLL/HLL.html">•HLL Sketch</a></li>
+ <li><a href="/docs/HLL/HllMap.html">•HLL Map Sketch</a></li>
+
+ <p id="hll-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_hll_examples">HLL Examples</a>
+ </p>
+ <div class="collapse" id="collapse_hll_examples">
+ <li><a href="/docs/HLL/HllJavaExample.html">•HLL Sketch Java
Example</a></li>
+ <li><a href="/docs/HLL/HllCppExample.html">•HLL Sketch C++
Example</a></li>
+ <li><a href="/docs/HLL/HllPigUDFs.html">•HLL Sketch Pig UDFs</a></li>
+ <li><a href="/docs/HLL/HllHiveUDFs.html">•HLL Sketch Hive
UDFs</a></li>
+ </div>
+
+ <p id="hll-studies">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_hll_studies">HLL Studies</a>
+ </p>
+ <div class="collapse" id="collapse_hll_studies">
+ <li><a href="/docs/HLL/HllPerformance.html">•HLL Sketch
Performance</a></li>
+ <li><a href="/docs/HLL/Hll_vs_CS_Hllpp.html">•HLL vs Clearspring
HLL++</a></li>
+ <li><a
href="/docs/HLL/HllSketchVsDruidHyperLogLogCollector.html">•HLL Sketch vs Druid
HyperLogLogCollector</a></li>
+ </div>
+ </div>
+
+ <p id="theta-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_theta_sketches">Theta Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_theta_sketches">
+ <li><a href="/docs/Theta/ThetaSketchFramework.html">•Theta Sketch
Framework</a></li>
+
+ <p id="theta-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_theta_examples">Theta Examples</a>
+ </p>
+ <div class="collapse" id="collapse_theta_examples">
+ <li><a href="/docs/Theta/ConcurrentThetaSketch.html">•Concurrent
Theta Sketch</a></li>
+ <li><a href="/docs/Theta/ThetaJavaExample.html">•Theta Sketch Java
Example</a></li>
+ <li><a href="/docs/Theta/ThetaSparkExample.html">•Theta Sketch Spark
Example</a></li>
+ <li><a href="/docs/Theta/ThetaPigUDFs.html">•Theta Sketch Pig
UDFs</a></li>
+ <li><a href="/docs/Theta/ThetaHiveUDFs.html">•Theta Sketch Hive
UDFs</a></li>
+ </div>
+
+ <p id="kmv-tutorial">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_kmv_tutorial">KMV Tutorial</a>
+ </p>
+ <div class="collapse" id="collapse_kmv_tutorial">
+ <li><a href="/docs/Theta/InverseEstimate.html">•The Inverse
Estimate</a></li>
+ <li><a href="/docs/Theta/KMVempty.html">•Empty Sketch</a></li>
+ <li><a href="/docs/Theta/KMVfirstEst.html">•First Estimator</a></li>
+ <li><a href="/docs/Theta/KMVbetterEst.html">•Better
Estimator</a></li>
+ <li><a href="/docs/Theta/KMVrejection.html">•Rejection Rules</a></li>
+ <li><a href="/docs/Theta/KMVupdateVkth.html">•Update V(kth)
Rule</a></li>
+ </div>
+
+ <p id="set-operations-and-p-sampling">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_set_operations_and_p-sampling">Set Operations and P-sampling</a>
+ </p>
+ <div class="collapse" id="collapse_set_operations_and_p-sampling">
+ <li><a href="/docs/Theta/ThetaSketchSetOps.html">•Set
Operations</a></li>
+ <li><a
href="/docs/Theta/ThetaPSampling.html">•<i>p</i>-Sampling</a></li>
+ </div>
+
+ <p id="accuracy">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_accuracy">Accuracy</a>
+ </p>
+ <div class="collapse" id="collapse_accuracy">
+ <li><a href="/docs/Theta/ThetaAccuracy.html">•Basic Accuracy</a></li>
+ <li><a href="/docs/Theta/ThetaAccuracyPlots.html">•Accuracy
Plots</a></li>
+ <li><a href="/docs/Theta/ThetaErrorTable.html">•Relative Error
Table</a></li>
+ <li><a href="/docs/Theta/ThetaSketchSetOpsAccuracy.html">•SetOp
Accuracy</a></li>
+ <li><a href="/docs/Theta/AccuracyOfDifferentKUnions.html">•Unions
With Different k</a></li>
+ </div>
+
+ <p id="size">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_size">Size</a>
+ </p>
+ <div class="collapse" id="collapse_size">
+ <li><a href="/docs/Theta/ThetaSize.html">•Theta Sketch Size</a></li>
+ </div>
+
+ <p id="speed">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_speed">Speed</a>
+ </p>
+ <div class="collapse" id="collapse_speed">
+ <li><a href="/docs/Theta/ThetaUpdateSpeed.html">•Update
Speed</a></li>
+ <li><a href="/docs/Theta/ThetaMergeSpeed.html">•Merge Speed</a></li>
+ </div>
+
+ <p id="theta-sketch-theory">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_theta_sketch_theory">Theta Sketch Theory</a>
+ </p>
+ <div class="collapse" id="collapse_theta_sketch_theory">
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/ThetaSketchFramework.pdf";>•Theta
Sketch Framework (PDF)</a></li>
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/SketchEquations.pdf";>•Sketch
Equations (PDF)</a></li>
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/DataSketches.pdf";>•DataSketches
(PDF)</a></li>
+ <li><a href="/docs/Theta/ThetaConfidenceIntervals.html">•Confidence
Intervals Notes</a></li>
+ <li><a href="/docs/Theta/ThetaMergingAlgorithm.html">•Merging
Algorithm Notes</a></li>
+ <li><a href="/docs/Theta/ThetaReferences.html">•Theta
References</a></li>
+ </div>
+ </div>
+
+ <p id="tuple-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_tuple_sketches">Tuple Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_tuple_sketches">
+ <li><a href="/docs/Tuple/TupleOverview.html">•Tuple Overview</a></li>
+
+ <p id="tuple-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_tuple_examples">Tuple Examples</a>
+ </p>
+ <div class="collapse" id="collapse_tuple_examples">
+ <li><a href="/docs/Tuple/TupleJavaExample.html">•Tuple Java
Example</a></li>
+ <li><a href="/docs/Tuple/TupleEngagementExample.html">•Tuple
Engagement Example</a></li>
+ <li><a href="/docs/Tuple/TuplePigUDFs.html">•Tuple Pig UDFs</a></li>
+ <li><a href="/docs/Tuple/TupleHiveUDFs.html">•Tuple Hive
UDFs</a></li>
+ </div>
+ </div>
+ </div>
+
+ <p id="most-frequent">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_most_frequent">Most Frequent</a>
+ </p>
+ <div class="collapse" id="collapse_most_frequent">
+ <li><a href="/docs/Frequency/FrequencySketchesOverview.html">•Frequency
Sketches Overview</a></li>
+
+ <p id="frequent-item-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_frequent_item_sketches">Frequent Item Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_frequent_item_sketches">
+ <li><a href="/docs/Frequency/FrequentItemsOverview.html">•Frequent
Items Overview</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsErrorTable.html">•Frequent
Items Error Table</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsReferences.html">•Frequent
Items References</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsPerformance.html">•Frequent
Items Performance</a></li>
+
+ <p id="most-frequent-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_most_frequent_examples">Most Frequent Examples</a>
+ </p>
+ <div class="collapse" id="collapse_most_frequent_examples">
+ <li><a
href="/docs/Frequency/FrequentItemsJavaExample.html">•Frequent Items Java
Example</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsCppExample.html">•Frequent
Items C++ Example</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsPigUDFs.html">•Frequent
Items Pig UDFs</a></li>
+ <li><a href="/docs/Frequency/FrequentItemsHiveUDFs.html">•Frequent
Items Hive UDFs</a></li>
+ </div>
+ </div>
+
+ <p id="frequent-distinct-sketches">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_frequent_distinct_sketches">Frequent Distinct Sketches</a>
+ </p>
+ <div class="collapse" id="collapse_frequent_distinct_sketches">
+ <li><a
href="/docs/Frequency/FrequentDistinctTuplesSketch.html">•Frequent Distinct
Tuples Sketch</a></li>
+ </div>
+ </div>
+
+ <p id="quantiles-and-histograms">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_and_histograms">Quantiles And Histograms</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_and_histograms">
+ <li><a href="/docs/Quantiles/QuantilesOverview.html">•Quantiles
Overview</a></li>
+ <li><a href="/docs/Quantiles/QuantilesAccuracy.html">•Quantiles Accuracy
and Size</a></li>
+
+ <p id="quantiles-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_examples">Quantiles Examples</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_examples">
+ <li><a href="/docs/Quantiles/QuantilesJavaExample.html">•Quantiles
Sketch Java Example</a></li>
+ <li><a href="/docs/Quantiles/QuantilesCppExample.html">•KLL Quantiles
Sketch C++ Example</a></li>
+ <li><a href="/docs/Quantiles/QuantilesPigUDFs.html">•Quantiles Sketch
Pig UDFs</a></li>
+ <li><a href="/docs/Quantiles/QuantilesHiveUDFs.html">•Quantiles Sketch
Hive UDFs</a></li>
+ </div>
+
+ <p id="quantiles-studies">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_studies">Quantiles Studies</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_studies">
+ <li><a href="/docs/Quantiles/Definitions.html">•Definitions for
Quantiles Studies</a></li>
+ <li><a href="/docs/Quantiles/KLLSketch.html">•New KLL sketch and
comparison with DoublesSketch</a></li>
+ <li><a href="/docs/Quantiles/KllSketchVsTDigest.html">•KLL sketch vs
t-digest</a></li>
+ <li><a href="/docs/Quantiles/DruidApproxHistogramStudy.html">•Druid
Approximate Histogram</a></li>
+ <li><a href="/docs/Quantiles/MomentsSketchStudy.html">•Moments Sketch
Study</a></li>
+ <li><a href="/docs/Quantiles/QuantilesStreamAStudy.html">•Quantiles
StreamA Study</a></li>
+ <li><a href="/docs/Quantiles/ExactQuantiles.html">•Exact Quantiles for
Studies</a></li>
+ </div>
+
+ <p id="quantiles-sketch-theory">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_quantiles_sketch_theory">Quantiles Sketch Theory</a>
+ </p>
+ <div class="collapse" id="collapse_quantiles_sketch_theory">
+ <li><a
href="https://github.com/apache/datasketches-website/tree/master/docs/pdf/Quantiles_KLL.pdf";>•Optimal
Quantile Approximation in Streams</a></li>
+ <li><a href="/docs/Quantiles/QuantilesReferences.html">•Quantiles
References</a></li>
+ </div>
+ </div>
+
+ <p id="sampling">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_sampling">Sampling</a>
+ </p>
+ <div class="collapse" id="collapse_sampling">
+ <li><a href="/docs/Sampling/ReservoirSampling.html">•Reservoir
Sampling</a></li>
+ <li><a
href="/docs/Sampling/ReservoirSamplingPerformance.html">•Reservoir Sampling
Performance</a></li>
+ <li><a href="/docs/Sampling/VarOptSampling.html">•VarOpt
Sampling</a></li>
+
+ <p id="sampling-examples">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_sampling_examples">Sampling Examples</a>
+ </p>
+ <div class="collapse" id="collapse_sampling_examples">
+ <li><a href="/docs/Sampling/ReservoirSamplingJava.html">•Reservoir
Sampling Java Example</a></li>
+ <li><a href="/docs/Sampling/ReservoirSamplingPigUDFs.html">•Reservoir
Sampling Pig UDFs</a></li>
+ <li><a href="/docs/Sampling/VarOptSamplingJava.html">•VarOpt Sampling
Java Example</a></li>
+ <li><a href="/docs/Sampling/VarOptPigUDFs.html">•VarOpt Sampling Pig
UDFs</a></li>
+ </div>
+ </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="/docs/SystemIntegrations/ApacheDruidIntegration.html">•Using
Sketches in ApacheDruid</a></li>
+ <li><a href="/docs/SystemIntegrations/ApacheHiveIntegration.html">•Using
Sketches in Apache Hive</a></li>
+ <li><a href="/docs/SystemIntegrations/ApachePigIntegration.html">•Using
Sketches in Apache Pig</a></li>
+ <li><a href="/docs/SystemIntegrations/PostgreSQLIntegration.html">•Using
Sketches in PostgreSQL</a></li>
+ </div>
+
+ <p id="community">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_community">Community</a>
+ </p>
+ <div class="collapse" id="collapse_community">
+ <li><a href="/docs/Community/index.html">•Community</a></li>
+ <li><a href="/docs/Community/Downloads.html">•Downloads</a></li>
+ <li><a href="/docs/Community/NewCommitterProcess.html">•New Committer
Process</a></li>
+ <li><a href="/docs/Community/ProcessForCppComponentReleases.html">•Process
For CPP Component Releases</a></li>
+ <li><a
href="/docs/Community/ProcessForJavaComponentReleases.html">•Process For Java
Component Releases</a></li>
+ <li><a href="/docs/Community/Transitioning.html">•Transitioning from prior
GitHub Site</a></li>
+ <li><a href="/docs/Community/WhoUses.html">•Who Uses</a></li>
+ </div>
+
+ <p id="research">
+ <a data-toggle="collapse" class="menu collapsed"
href="#collapse_research">Research</a>
+ </p>
+ <div class="collapse" id="collapse_research">
+ <li><a href="/docs/Community/Research.html">•Research</a></li>
+ </div>
+</div>
+<!-- End _includes/toc.html -->
+
+
+<!-- Start _includes/tocScript.html -->
+<script>
+ (function () {
+
+ var findLineItem = function (path) {
+ return document.querySelector(`#toc [href="${path}"]`);
+ };
+
+ function findNavItem(path) {
+ return document.querySelector(`.nav [href="${path}"]`);
+ }
+
+ var highlighLineItem = function (element) {
+ element.classList.add('highlight');
+ };
+
+ var checkHasClass = function (element, className) {
+ return element.className.split(' ').find(function (item) { return item
=== className || '' })
+ }
+
+ var findAllCollapseParents = function (element) {
+ var collapseMenus = [];
+ var elementPointer = element;
+ while (elementPointer !== document.body) {
+ if (checkHasClass(elementPointer, 'collapse')) {
+ collapseMenus.push(elementPointer);
+ }
+ elementPointer = elementPointer.parentElement
+ }
+ return collapseMenus
+ };
+
+ var openMenuItem = function (element) {
+ // $(element).collapse('show') would start a transition, adding `in`
class instead.
+ element.classList.add('in');
+ };
+
+ var openAllFromList = function (elementList) {
+ elementList.forEach(openMenuItem);
+ };
+
+ var highlightAndOpenMenu = function () {
+ // Highlight & expand nav item in the TOC
+ var currentLineItem = findLineItem(document.location.pathname);
+ highlighLineItem(currentLineItem);
+ openAllFromList(findAllCollapseParents(currentLineItem));
+
+ // Highlight nav item in top navigation
+ highlighLineItem(findNavItem(document.location.pathname));
+ };
+
+ $(highlightAndOpenMenu);
+
+ }());
+</script>
+<!-- End _includes/tocScript.html -->
+
+ </div>
+ <!-- End ToC Block -->
+ <div class="col-md-9 doc-content">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<h1 id="process-for-java-component-releases">Process For Java Component
Releases</h1>
+<p><strong>NOTES:</strong></p>
+
+<ul>
+ <li>This process covers major and minor releases only. Bug-fix releases,
which increment the third digit, are performed on a A.B.X branch and not on
master, but otherwise are similar.</li>
+ <li>Some of these operations can be performed either on the Command-Line or
in your IDE, whatever you prefer.</li>
+</ul>
+
+<h2 id="preparation">Preparation</h2>
+<ul>
+ <li>Confirm correctness for
+ <ul>
+ <li>LICENSE</li>
+ <li>NOTICE – check for copyright dates</li>
+ <li>README.md</li>
+ <li>.travis.yml</li>
+ <li>.gitignore</li>
+ <li>pom.xml</li>
+ </ul>
+ </li>
+ <li>From Command Line or IDE:
+ <ul>
+ <li>Run Unit tests</li>
+ <li>Run Code Coverage > 90%</li>
+ <li>Run SpotBugs checks (is it properly configured?)</li>
+ <li>Run Checkstyle (is it properly configured?)</li>
+ <li>Confirm that all <strong>temporary</strong> branches are checked
into master and/or deleted, both local and remote.</li>
+ <li>Confirm any new bug fixes have corresponding tests</li>
+ </ul>
+ </li>
+ <li>From Command Line at Component root:
+ <ul>
+ <li>Confirm GPG is running (check this every time you open a new
Terminal):
+ <ul>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>$ env</td>
+ <td>grep GPG # you should see something like:
GPG_TTY=/dev/ttys000</td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+ <li>To start GPG if GPG Agent is not running:
+ <ul>
+ <li>$ eval $(gpg-agent –daemon)</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>Confirm GitHub repository is current and git status is clean:
+ <ul>
+ <li>$ git status
+ <ul>
+ <li>“nothing to commit, working tree clean”</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>At major version releases, search for deprecated code and remove at
<strong>Major Versions</strong> only.
+ <ul>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>$ find . -name “*.java” -type f -print</td>
+ <td>xargs grep -i -n -s -A0 “deprecated”</td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+ </ul>
+ </li>
+ <li>Check Maven Versions:
+ <ul>
+ <li>$ mvn versions:display-plugin-updates</li>
+ </ul>
+ </li>
+ <li>Maven Tests:
+ <ul>
+ <li>$ mvn apache-rat:check</li>
+ <li>$ mvn clean test</li>
+ <li>$ mvn clean test -P strict</li>
+ <li>$ mvn clean javadoc:javadoc</li>
+ <li>$ mvn clean install -DskipTests=true</li>
+ <li>Check that the /target/ directory has 5 jars:
+ <ul>
+ <li>-javadoc.jar</li>
+ <li>-sources.jar</li>
+ <li>-test-sources.jar</li>
+ <li>-tests.jar</li>
+ <li>-.jar</li>
+ </ul>
+ </li>
+ <li>Check your local Maven repository
+ <ul>
+
<li><em>~/.m2/repository/org/apache/datasketches/datasketches-<component>/A.B.0-SNAPSHOT/</em></li>
+ <li>It should have 5 new jars and a .pom file.</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create-permanent-release-branch--pom-version-preparation">Create
Permanent Release Branch & POM Version Preparation</h2>
+<ul>
+ <li>Assume current master POM version = A.B.0-SNAPSHOT</li>
+ <li>From IDE or Command Line:
+ <ul>
+ <li>Switch from Master to new <strong>Permanent Branch</strong>:
“A.B.X”</li>
+ <li>Edit pom.xml version to A.B.0 (remove -SNAPSHOT, do not change A or
B)</li>
+ <li>Commit the change. <strong>DO NOT PUSH!</strong></li>
+ <li>Create Annotated TAG: A.B.0-RC1 (or RCn)</li>
+ <li>Write down the Git hash : example: 40c6f4f</li>
+ <li>Now Push Branch “A.B.X” with edited pom.xml to origin</li>
+ <li><strong>DO NOT MERGE THIS PERMANENT BRANCH INTO MASTER</strong></li>
+ </ul>
+ </li>
+ <li>From IDE or Command-line:
+ <ul>
+ <li>Do explicit push of tags on branch “A.B.X” to origin:
+ <ul>
+ <li>$ git push origin –tags</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>From a web browser at origin web site:
github.com/apache/datasketches-<component>
+ <ul>
+ <li>Select the A.B.X branch</li>
+ <li>Confirm that the tag: A.B.0-RC1 exists and that the tag is on the
latest commit and with the correct Git hash.</li>
+ <li><strong>DO NOT CREATE PR OR MERGE THIS PERMANENT BRANCH INTO
MASTER</strong></li>
+ </ul>
+ </li>
+ <li>From IDE or Command Line:
+ <ul>
+ <li>Confirm that the tag A.B.0-RC1 and the branch A.B.X, and HEAD
coincide with the correct Git hash.</li>
+ <li>Confirm that there are no unstaged or staged changes.</li>
+ <li>Return to master branch</li>
+ <li>Edit master pom.xml to A’.B’.0-SNAPSHOT where A’ or B’ will be
incremented by 1. (Bug fix releases will change the 3rd digit)</li>
+ <li>Commit and Push this change to origin/master with the comment
“Release Process: Change pom version to A’.B’.0-SNAPSHOT.”</li>
+ <li>Return to release branch A.B.X</li>
+ <li>You may minimize your IDE, pointing at the release branch.</li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create-andor-checkout-local-distdev-directories-on-your-system">Create
and/or Checkout Local <em>dist/dev</em> directories on your system</h2>
+<ul>
+ <li>If you have not already, on your system create the two directory
structures that mirror the dist.apache.org/repos/ directories:
+ <ul>
+ <li>mkdir dist/dev/datasketches/</li>
+ <li>mkdir dist/release/datasketches/</li>
+ </ul>
+ </li>
+ <li>Checkout both “dev” and “release” directories
+ <ul>
+ <li>Open a terminal in the dist/dev/datasketches directory and do a
checkout:
+ <ul>
+ <li>svn co https://dist.apache.org/repos/dist/dev/datasketches/ .
#Note the DOT</li>
+ <li>svn status # make sure it is clean</li>
+ </ul>
+ </li>
+ <li>Open a terminal in the dist/release/datasketches directory and do a
checkout:
+ <ul>
+ <li>svn co https://dist.apache.org/repos/dist/release/datasketches/
. #Note the DOT</li>
+ <li>svn status # make sure it is clean</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create-the-candidate-apache-release-distribution-on-distdev">Create
the Candidate Apache Release Distribution on <em>dist/dev</em></h2>
+<h3 id="create-primary-zip-files--signatures">Create primary zip files &
signatures</h3>
+<ul>
+ <li>You will need the following arguments:
+ <ul>
+ <li>Absolute path of target project.basedir on your system</li>
+ <li>Project.artifactId : datasketches-<component> where component
is e.g., java, pig, hive,…</li>
+ <li>GitHub Tag: A.B.0-RC1 (or RCn)</li>
+ <li>Have your GPG passphrase handy – you have only a few seconds to
enter it!</li>
+ </ul>
+ </li>
+ <li>Start a new terminal in the above dist/dev/datasketches/scripts
directory on your system:
+ <ul>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>Confirm GPG is running: $ env</td>
+ <td>grep GPG</td>
+ </tr>
+ </tbody>
+ </table>
+ <ul>
+ <li>If not: $ eval $(gpg-agent –daemon)</li>
+ </ul>
+ </li>
+ <li>Run something like:
+ <ul>
+ <li>$ ./bashDeployToDist.sh
/Users/<name>/dev/git/Apache/datasketches-<component>
datasketches-<component> A.B.0-RC1</li>
+ <li>Follow the instructions.</li>
+ <li>NOTE: if you get the error “gpg: signing failed: No pinentry”:
+ <ul>
+ <li>open .gnupg/gpg-agent.conf</li>
+ <li>change to: pinentry-program /usr/local/bin/pinentry-tty</li>
+ <li>reload the gpg agent in the terminal: gpg-connect-agent
reloadagent /bye</li>
+ <li>restart the ./bashDeployToDist script</li>
+ </ul>
+ </li>
+ <li>Close the terminal</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>Check and grab the web URL ~
https://dist.apache.org/repos/dist/dev/datasketches/<component>/A.B.0-RC1/
+ <ul>
+ <li>There should be 3 files: *-src.zip, *-src.zip.asc,
*-src.zip.sha512</li>
+ </ul>
+ </li>
+</ul>
+
+<h3 id="java-push-jars-to-nexus-maven-central-staging">Java: Push Jars to
Nexus (Maven Central) Staging</h3>
+<ul>
+ <li>Return to original terminal at the project.basedir</li>
+ <li>
+ <table>
+ <tbody>
+ <tr>
+ <td>If starting new terminal make sure GPG is running: $ env</td>
+ <td>grep GPG</td>
+ </tr>
+ </tbody>
+ </table>
+ <ul>
+ <li>If not: $ eval $(gpg-agent –daemon)</li>
+ </ul>
+ </li>
+ <li>$ git status # make sure you are still on the release branch: _A.B.X</li>
+ <li>TRIAL-RUN:
+ <ul>
+ <li>$ mvn clean install -Pnexus-jars -DskipTests=true
+ <ul>
+ <li>Check that jars & pom have .asc signatures</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>DEPLOY
+ <ul>
+ <li>$ mvn clean deploy -Pnexus-jars -DskipTests=true
+ <ul>
+ <li>Login to <a
href="https://repository.apache.org/";>repository.apache.org</a> / Staging
Repositories for orgapachedatasketches-XXXX</li>
+ <li>Click Content and search to the end. Each jar & pom should
have .asc, .md5, .sha1 signatures</li>
+ <li>[CLOSE] the Staging Repository with a comment:
“<component> A.B.0”</li>
+ <li>Confirm its existance under Repositories/Staging web-site :
org/apache/datasketches-<component>/A.B.0</li>
+ <li>Grab its URL while there. You will need it for the Vote
Letter.</li>
+ <li>Check your local Maven repository
+ <ul>
+
<li><em>~/.m2/repository/org/apache/datasketches/datasketches-<component>/A.B.0/</em></li>
+ <li>It should have 5 new jars and a .pom file each with .asc,
.md5, and .sha1 signatures</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h3 id="create-copy-of-external-artifact-distributions">Create Copy of
External Artifact Distributions</h3>
+<ul>
+ <li>For Java, we need to place copies of the artifact jars deployed to Nexus
under a “maven” directory.</li>
+ <li>For external artifacts of Python or Docker it will be something
else.</li>
+ <li>For example see <a
href="https://dist.apache.org/repos/dist/release/datasketches/java/1.3.0-incubating/";>https://dist.apache.org/repos/dist/release/datasketches/java/1.3.0-incubating/</a></li>
+ <li>These must be signed with GPG (.asc) and SHA512 (.sha512)</li>
+ <li>I will create a script for these artifacts someday :)</li>
+</ul>
+
+<h2 id="prepare--send-vote-letter-to-dev">Prepare & Send [VOTE] Letter to
dev@</h2>
+<ul>
+ <li>See VoteTemplates directory for a recent example</li>
+ <li>If vote is not successful, fix the problem and repeat above steps.</li>
+ <li>After a successful vote return to <strong>this point</strong> and
continue …</li>
+</ul>
+
+<h2 id="prepare--send-vote-result-letter-to-dev">Prepare & Send
[VOTE-RESULT] Letter to dev@</h2>
+<ul>
+ <li>See VoteTemplates directory for a recent example</li>
+ <li>Declare that the vote is closed.</li>
+ <li>Summarize vote results</li>
+</ul>
+
+<h2 id="move-files-from-devstaging-to-release">Move files from dev/staging to
release</h2>
+<h3 id="move-primary-zip-files-distdev-to-distrelease">Move primary zip files
<em>dist/dev</em> to <em>dist/release</em></h3>
+<ul>
+ <li>In local dist/<strong>dev</strong>/datasketches/
+ <ul>
+ <li>Open Terminal #1
+ <ul>
+ <li>Perform SVN Checkout:
+ <ul>
+ <li>$ svn co
https://dist.apache.org/repos/dist/dev/datasketches/ . #note dot at end</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>In local dist/<strong>release</strong>/datasketches/
+ <ul>
+ <li>Open Terminal #2
+ <ul>
+ <li>Perform SVN Checkout:
+ <ul>
+ <li>$ svn co
https://dist.apache.org/repos/dist/release/datasketches/ . #note dot at end</li>
+ </ul>
+ </li>
+ <li>Create new version directory under appropriate component
directory:
+ <ul>
+ <li>$ mkdir -p <component>/A.B.0</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li>Using local file system copy files
+ <ul>
+ <li>From …
/dist/dev/datasketches/<component>/version-RCnn/*</li>
+ <li>To … /dist/release/datasketches/<component>/version (no
RCnn)/*</li>
+ </ul>
+ </li>
+ <li>Using Terminal #2 at … /dist/release/datasketches directory:
+ <ul>
+ <li>svn add . –force</li>
+ <li>svn ci -m “Release A.B.0”</li>
+ <li>Remove the prior release…</li>
+ <li>svn remove <component>/X.Y.0</li>
+ <li>svn ci -m “Remove Prior release”</li>
+ <li>svn status # should be empty</li>
+ </ul>
+ </li>
+ <li>Using local file system
+ <ul>
+ <li>Delete the prior X.Y.0 directory</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+<h3 id="move-external-artifact-distributions-distdev-to-distrelease">Move
External Artifact Distributions <em>dist/dev</em> to <em>dist/release</em></h3>
+
+<h3 id="java-release-jars-on-nexus-staging">Java: Release Jars on Nexus
Staging</h3>
+<ul>
+ <li>On Nexus <a
href="https://repository.apache.org/";>repository.apache.org</a> click on
Staging Repositories</li>
+ <li>Select “orgapachedatasketches-XXXX” (If more than one make sure you
select the right one!)</li>
+ <li>At the top of the window, select “Release”</li>
+ <li>Confirm that the attributes have moved to the “Releases” repository
under “Repositories”
+ <ul>
+ <li>Browse to *Releases/org/apache/datasketches/…</li>
+ </ul>
+ </li>
+</ul>
+
+<h2 id="create--document-release-tag-on-github">Create & Document Release
Tag on GitHub</h2>
+<ul>
+ <li>Open your IDE and switch to the recently created Release Branch
A.B.X</li>
+ <li>Find the recently created A.B.0-RCn tag in that branch</li>
+ <li>At that same GitHub ID hash, create a new tag A.B.0 (without the
RCn).</li>
+ <li>From the Command Line: Push the new tag to origin:
+ <ul>
+ <li>$ git push origin –tags</li>
+ </ul>
+ </li>
+ <li>On the GitHub component site document the release</li>
+</ul>
+
+<h2 id="update-website-downloadsmd-latest-source-zip-files-table">Update
Website Downloads.md “Latest Source Zip Files” Table</h2>
+<ul>
+ <li>This script assumes that the remote …/dist/release/datasketches/…
directories are up-to-date with no old releases.</li>
+ <li>Start a new terminal in the ../dist/dev/datasketches/scripts directory
on your system:</li>
+ <li>Make sure you local website directory is pointing to master and
up-to-date.</li>
+ <li>Run the following with the argument specifying the location of your
local website directory:
+ <ul>
+ <li>$ ./createDownloadsInclude.sh /Users/<name>/ …
/datasketches-website</li>
+ </ul>
+ </li>
+ <li>When this is done, be sure to commit the changes to the website.</li>
+</ul>
+
+<h2 id="update-javadocs-or-equivalent-on-website">Update Javadocs (or
Equivalent) on Website</h2>
+
+<h2 id="update-website-documentation-if-new-functionality">Update Website
Documentation (if new functionality)</h2>
+
+<h2 id="prepare-announce-letter-to-dev">Prepare Announce Letter to dev@</h2>
+<ul>
+ <li>ASF requests that you wait 24 hours to publish Announce letter to allow
the propagation to mirrors.</li>
+ <li>Use recent template</li>
+ <li>Summarize vote results</li>
+</ul>
+
+<h2 id="update-these-instructions">Update These Instructions</h2>
+<ul>
+ <li>If you have updated this file or any of the scripts, please check it in
using SVN using your local dist/dev directory copy:
+ <ul>
+ <li>$ svn status</li>
+ <li>$ svn add . –force # if adding a file for the first time</li>
+ <li>$ svn ci -m “update Release Steps”</li>
+ </ul>
+ </li>
+</ul>
+
+ </div> <!-- End content -->
+ </div> <!-- End row -->
+ </div> <!-- End Container -->
+
+<!-- Start _include/page_footer.html -->
+<footer class="ds-footer">
+ <div class="container">
+ <div class="text-center">
+ <p>
+ <div>Copyright © 2020 <a href="https://www.apache.org";>Apache Software
Foundation</a>,
+ Licensed under the Apache License, Version 2.0. All Rights
Reserved.<br/>
+ Apache DataSketches, Apache, the Apache feather logo, and the Apache
DataSketches project logos are trademarks of The Apache Software
Foundation.<br/>
+ All other marks mentioned may be trademarks or registered trademarks
of their respective owners.
+ </div>
+ </p>
+ </div>
+ </div>
+</footer>
+<!-- End _include/page_footer.html -->
+
+</body>
+
+</html>
+<!-- End _layouts/doc_page.html-->
\ No newline at end of file
diff --git a/output/docs/Community/ProcessForJavaComponentReleases.md
b/output/docs/Community/ProcessForJavaComponentReleases.md
deleted file mode 100644
index 23fce8c..0000000
--- a/output/docs/Community/ProcessForJavaComponentReleases.md
+++ /dev/null
@@ -1,231 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-# Process For Java Component Releases
-__NOTES:__
-
-* This process covers major and minor releases only. Bug-fix releases, which
increment the third digit, are performed on a A.B.X branch and not on master,
but otherwise are similar.
-* Some of these operations can be performed either on the Command-Line or in
your IDE, whatever you prefer.
-
-## Preparation
-* Confirm correctness for
- * LICENSE
- * NOTICE -- check for copyright dates
- * README.md
- * .travis.yml
- * .gitignore
- * pom.xml
-
-* From Command Line or IDE:
- * Run Unit tests
- * Run Code Coverage > 90%
- * Run SpotBugs checks (is it properly configured?)
- * Run Checkstyle (is it properly configured?)
- * Confirm that all __temporary__ branches are checked into master and/or
deleted, both local and remote.
- * Confirm any new bug fixes have corresponding tests
-
-* From Command Line at Component root:
- * Confirm GPG is running (check this every time you open a new Terminal):
- * $ env | grep GPG # you should see something like: GPG_TTY=/dev/ttys000
- * To start GPG if GPG Agent is not running:
- * $ eval $(gpg-agent --daemon)
- * Confirm GitHub repository is current and git status is clean:
- * $ git status
- * "nothing to commit, working tree clean"
- * At major version releases, search for deprecated code and remove at
__Major Versions__ only.
- * $ find . -name "*.java" -type f -print | xargs grep -i -n -s -A0
"deprecated"
- * Check Maven Versions:
- * $ mvn versions:display-plugin-updates
- * Maven Tests:
- * $ mvn apache-rat:check
- * $ mvn clean test
- * $ mvn clean test -P strict
- * $ mvn clean javadoc:javadoc
- * $ mvn clean install -DskipTests=true
- * Check that the /target/ directory has 5 jars:
- * -javadoc.jar
- * -sources.jar
- * -test-sources.jar
- * -tests.jar
- * -.jar
- * Check your local Maven repository
- *
_~/.m2/repository/org/apache/datasketches/datasketches-\<component\>/A.B.0-SNAPSHOT/_
- * It should have 5 new jars and a .pom file.
-
-
-## Create Permanent Release Branch & POM Version Preparation
-* Assume current master POM version = A.B.0-SNAPSHOT
-* From IDE or Command Line:
- * Switch from Master to new __Permanent Branch__: "A.B.X"
- * Edit pom.xml version to A.B.0 (remove -SNAPSHOT, do not change A or B)
- * Commit the change. __DO NOT PUSH!__
- * Create Annotated TAG: A.B.0-RC1 (or RCn)
- * Write down the Git hash : example: 40c6f4f
- * Now Push Branch "A.B.X" with edited pom.xml to origin
- * __DO NOT MERGE THIS PERMANENT BRANCH INTO MASTER__
-* From IDE or Command-line:
- * Do explicit push of tags on branch "A.B.X" to origin:
- * $ git push origin --tags
-* From a web browser at origin web site:
github.com/apache/datasketches-\<component\>
- * Select the A.B.X branch
- * Confirm that the tag: A.B.0-RC1 exists and that the tag is on the latest
commit and with the correct Git hash.
- * __DO NOT CREATE PR OR MERGE THIS PERMANENT BRANCH INTO MASTER__
-* From IDE or Command Line:
- * Confirm that the tag A.B.0-RC1 and the branch A.B.X, and HEAD coincide
with the correct Git hash.
- * Confirm that there are no unstaged or staged changes.
- * Return to master branch
- * Edit master pom.xml to A'.B'.0-SNAPSHOT where A' or B' will be
incremented by 1. (Bug fix releases will change the 3rd digit)
- * Commit and Push this change to origin/master with the comment "Release
Process: Change pom version to A'.B'.0-SNAPSHOT."
- * Return to release branch A.B.X
- * You may minimize your IDE, pointing at the release branch.
-
-## Create and/or Checkout Local *dist/dev* directories on your system
-* If you have not already, on your system create the two directory structures
that mirror the dist.apache.org/repos/ directories:
- * mkdir dist/dev/datasketches/
- * mkdir dist/release/datasketches/
-* Checkout both "dev" and "release" directories
- * Open a terminal in the dist/dev/datasketches directory and do a checkout:
- * svn co https://dist.apache.org/repos/dist/dev/datasketches/ .
#Note the DOT
- * svn status # make sure it is clean
- * Open a terminal in the dist/release/datasketches directory and do a
checkout:
- * svn co https://dist.apache.org/repos/dist/release/datasketches/ .
#Note the DOT
- * svn status # make sure it is clean
-
-## Create the Candidate Apache Release Distribution on *dist/dev*
-### Create primary zip files & signatures
-* You will need the following arguments:
- * Absolute path of target project.basedir on your system
- * Project.artifactId : datasketches-\<component\> where component is e.g.,
java, pig, hive,...
- * GitHub Tag: A.B.0-RC1 (or RCn)
- * Have your GPG passphrase handy -- you have only a few seconds to enter it!
-* Start a new terminal in the above dist/dev/datasketches/scripts directory on
your system:
- * Confirm GPG is running: $ env | grep GPG
- * If not: $ eval $(gpg-agent --daemon)
- * Run something like:
- * $ ./bashDeployToDist.sh
/Users/\<name\>/dev/git/Apache/datasketches-\<component\>
datasketches-\<component\> A.B.0-RC1
- * Follow the instructions.
- * NOTE: if you get the error "gpg: signing failed: No pinentry":
- * open .gnupg/gpg-agent.conf
- * change to: pinentry-program /usr/local/bin/pinentry-tty
- * reload the gpg agent in the terminal: gpg-connect-agent reloadagent
/bye
- * restart the ./bashDeployToDist script
- * Close the terminal
-* Check and grab the web URL ~
https://dist.apache.org/repos/dist/dev/datasketches/\<component\>/A.B.0-RC1/
- * There should be 3 files: \*-src.zip, \*-src.zip.asc, \*-src.zip.sha512
-
-### Java: Push Jars to Nexus (Maven Central) Staging
-* Return to original terminal at the project.basedir
-* If starting new terminal make sure GPG is running: $ env | grep GPG
- * If not: $ eval $(gpg-agent --daemon)
-* $ git status # make sure you are still on the release branch: _A.B.X
-* TRIAL-RUN:
- * $ mvn clean install -Pnexus-jars -DskipTests=true
- * Check that jars & pom have .asc signatures
-* DEPLOY
- * $ mvn clean deploy -Pnexus-jars -DskipTests=true
- * Login to [repository.apache.org](https://repository.apache.org/) /
Staging Repositories for orgapachedatasketches-XXXX
- * Click Content and search to the end. Each jar & pom should have .asc,
.md5, .sha1 signatures
- * [CLOSE] the Staging Repository with a comment: "\<component\> A.B.0"
- * Confirm its existance under Repositories/Staging web-site :
org/apache/datasketches-\<component\>/A.B.0
- * Grab its URL while there. You will need it for the Vote Letter.
- * Check your local Maven repository
- *
_~/.m2/repository/org/apache/datasketches/datasketches-\<component\>/A.B.0/_
- * It should have 5 new jars and a .pom file each with .asc, .md5,
and .sha1 signatures
-
-### Create Copy of External Artifact Distributions
-* For Java, we need to place copies of the artifact jars deployed to Nexus
under a "maven" directory.
-* For external artifacts of Python or Docker it will be something else.
-* For example see
<https://dist.apache.org/repos/dist/release/datasketches/java/1.3.0-incubating/>
-* These must be signed with GPG (.asc) and SHA512 (.sha512)
-* I will create a script for these artifacts someday :)
-
-## Prepare & Send [VOTE] Letter to dev@
-* See VoteTemplates directory for a recent example
-* If vote is not successful, fix the problem and repeat above steps.
-* After a successful vote return to __this point__ and continue ...
-
-## Prepare & Send [VOTE-RESULT] Letter to dev@
-* See VoteTemplates directory for a recent example
-* Declare that the vote is closed.
-* Summarize vote results
-
-## Move files from dev/staging to release
-### Move primary zip files *dist/dev* to *dist/release*
-* In local dist/__dev__/datasketches/
- * Open Terminal #1
- * Perform SVN Checkout:
- * $ svn co https://dist.apache.org/repos/dist/dev/datasketches/ .
#note dot at end
-* In local dist/__release__/datasketches/
- * Open Terminal #2
- * Perform SVN Checkout:
- * $ svn co
https://dist.apache.org/repos/dist/release/datasketches/ . #note dot at end
- * Create new version directory under appropriate component directory:
- * $ mkdir -p \<component\>/A.B.0
- * Using local file system copy files
- * From ... /dist/dev/datasketches/\<component\>/version-RCnn/*
- * To ... /dist/release/datasketches/\<component\>/version (no
RCnn)/*
- * Using Terminal #2 at ... /dist/release/datasketches directory:
- * svn add . --force
- * svn ci -m "Release A.B.0"
- * Remove the prior release...
- * svn remove \<component\>/X.Y.0
- * svn ci -m "Remove Prior release"
- * svn status # should be empty
- * Using local file system
- * Delete the prior X.Y.0 directory
-
-### Move External Artifact Distributions *dist/dev* to *dist/release*
-
-### Java: Release Jars on Nexus Staging
-* On Nexus [repository.apache.org](https://repository.apache.org/) click on
Staging Repositories
-* Select "orgapachedatasketches-XXXX" (If more than one make sure you select
the right one!)
-* At the top of the window, select "Release"
-* Confirm that the attributes have moved to the "Releases" repository under
"Repositories"
- * Browse to *Releases/org/apache/datasketches/...
-
-## Create & Document Release Tag on GitHub
-* Open your IDE and switch to the recently created Release Branch A.B.X
-* Find the recently created A.B.0-RCn tag in that branch
-* At that same GitHub ID hash, create a new tag A.B.0 (without the RCn).
-* From the Command Line: Push the new tag to origin:
- * $ git push origin --tags
-* On the GitHub component site document the release
-
-## Update Website Downloads.md "Latest Source Zip Files" Table
-* This script assumes that the remote .../dist/release/datasketches/...
directories are up-to-date with no old releases.
-* Start a new terminal in the ../dist/dev/datasketches/scripts directory on
your system:
-* Make sure you local website directory is pointing to master and up-to-date.
-* Run the following with the argument specifying the location of your local
website directory:
- * $ ./createDownloadsInclude.sh /Users/\<name\>/ ... /datasketches-website
-* When this is done, be sure to commit the changes to the website.
-
-## Update Javadocs (or Equivalent) on Website
-
-## Update Website Documentation (if new functionality)
-
-## Prepare Announce Letter to dev@
-* ASF requests that you wait 24 hours to publish Announce letter to allow the
propagation to mirrors.
-* Use recent template
-* Summarize vote results
-
-## Update These Instructions
-* If you have updated this file or any of the scripts, please check it in
using SVN using your local dist/dev directory copy:
- * $ svn status
- * $ svn add . --force # if adding a file for the first time
- * $ svn ci -m "update Release Steps"
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
