This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/parquet-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 3dc0f70 deploy: ee98419b8698b35a5c29d863b359909cf1eea0fe
3dc0f70 is described below
commit 3dc0f70f04432e0757b69b938caf4e8a8d7a7c29
Author: Fokko <[email protected]>
AuthorDate: Wed Nov 13 12:31:22 2024 +0000
deploy: ee98419b8698b35a5c29d863b359909cf1eea0fe
---
output/docs/_print/index.html | 11 ++++++++++-
output/docs/contribution-guidelines/_print/index.html | 11 ++++++++++-
.../contribution-guidelines/contributing/index.html | 17 +++++++++++++----
output/docs/contribution-guidelines/index.xml | 18 ++++++++++++++++++
output/docs/index.xml | 18 ++++++++++++++++++
output/sitemap.xml | 2 +-
6 files changed, 70 insertions(+), 7 deletions(-)
diff --git a/output/docs/_print/index.html b/output/docs/_print/index.html
index b9a1cab..2eaa75a 100644
--- a/output/docs/_print/index.html
+++ b/output/docs/_print/index.html
@@ -815,7 +815,16 @@ initialize a scanner for each column and fast forward them
to the start row of
the scan.</p><p>The <code>min_values</code> and <code>max_values</code> are
calculated based on the <code>column_orders</code>
field in the <code>FileMetaData</code> struct of the footer.</p></div><div
class=td-content style=page-break-before:always><h1
id=pg-e0ad5830788d45de8b55e0c2b119349a>3.10 - Implementation status</h1><p>This
page summarizes the features supported by different Parquet
implementations.</p><p><em>Note</em>: This is a work in progress and we would
welcome help expanding its scope.</p><h3 id=legend>Legend</h3><p>The value in
each box means:</p><ul><li>✅: supported</li><li>❌: not
supported</li><li>(blank) no
data</li></ul><p>Implementations:</p><ul><li><code>C++</code>: <a
href=https://github.com/apache/arrow/tree/main/cpp/src/parquet>parquet-cpp</a></li><li><code>Java</code>:
<a
href=https://github.com/apache/parquet-java>parquet-java</a></li><li><code>Go
[...]
-Java resources can be build using <code>mvn package</code>. The current stable
version should always be available from Maven Central.</p><p>C++ thrift
resources can be generated via make.</p><p>Thrift can be also code-genned into
any other thrift-supported language.</p></div><div class=td-content
style=page-break-before:always><h1 id=pg-47cac26307c77b16f1b9e75c1e46efec>4.3 -
Contributing to Parquet-Java</h1><div class=lead>How to contribute to
Parquet-Java</div><h2 id=pull-requests>Pull [...]
+Java resources can be build using <code>mvn package</code>. The current stable
version should always be available from Maven Central.</p><p>C++ thrift
resources can be generated via make.</p><p>Thrift can be also code-genned into
any other thrift-supported language.</p></div><div class=td-content
style=page-break-before:always><h1 id=pg-47cac26307c77b16f1b9e75c1e46efec>4.3 -
Contributing to Parquet-Java</h1><div class=lead>How to contribute to
Parquet-Java</div><h2 id=pull-requests>Pull [...]
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @param c the current class
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @return the corresponding logger
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @deprecated will be removed in 2.0.0;
use org.slf4j.LoggerFactory instead.
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> */</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#5c35cc;font-weight:700>@Deprecated</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>public</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>static</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>Log</span><span style=color:#f8f8f8;text-decoration:underline>
</span><span style=color:#000>getLog</span><span style=color:#000 [...]
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>return</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>new</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>Log</span><span style=color:#000;font-weight:700>(</span><span
style=color:#000>c</span><span style=color:#000;font-weight:700> [...]
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#000;font-weight:700>}</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span></code></pre></div><p>Checking for API violations can be
done by running <code>mvn verify -Dmaven.test.skip=true
japicmp:cmp</code>.</p><h3 id=tracking-issues-using-milestones>Tracking issues
using Milestones</h3><p>When a PR is raised that fixes a bug, or a feature that
you want to target a certain version, make sure to attach a <a
href=https://github.com/apache/parquet-java/milestones>milestone</a>. This way
other committers can track certain versions, and see what [...]
</span></span></code></pre></div><p>Now you can cherry-pick a PR to a previous
branch:</p><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-sh data-lang=sh><span style=display:flex><span>get fetch --all
</span></span><span style=display:flex><span>git checkout parquet-1.14.x
</span></span><span style=display:flex><span>git reset --hard
github-apache/parquet-1.14.x
diff --git a/output/docs/contribution-guidelines/_print/index.html
b/output/docs/contribution-guidelines/_print/index.html
index 5153bde..b8ab848 100644
--- a/output/docs/contribution-guidelines/_print/index.html
+++ b/output/docs/contribution-guidelines/_print/index.html
@@ -5,7 +5,16 @@
"><meta name=twitter:card content="summary"><meta name=twitter:title
content="Developer Guide"><meta name=twitter:description content="All developer
resources related to Parquet.
"><link rel=preload
href=/scss/main.min.7f095589dcf99af199766009c9a9719e6fdf2b9ce9bcfbeb05e80eb6efeaf32b.css
as=style><link
href=/scss/main.min.7f095589dcf99af199766009c9a9719e6fdf2b9ce9bcfbeb05e80eb6efeaf32b.css
rel=stylesheet integrity><script
src=https://code.jquery.com/jquery-3.6.3.min.js
integrity="sha512-STof4xm1wgkfm7heWqFJVn58Hm3EtS31XFaagaa8VMReCXAkQnJZ+jEy8PCC/iT18dFy95WcExNHFTqLyp72eQ=="
crossorigin=anonymous></script><link rel=stylesheet
href=https://cdn.jsdelivr.net/npm/@doc [...]
<a href=# onclick="return print(),!1">Click here to print</a>.</p><p><a
href=/docs/contribution-guidelines/>Return to the regular view of this
page</a>.</p></div><h1 class=title>Developer Guide</h1><div class=lead>All
developer resources related to Parquet.</div><ul><li>1: <a
href=#pg-84c5df6519663fa8413f5c392f10dbd4>Sub-Projects</a></li><li>2: <a
href=#pg-0fc7677c5a8dcd5250334bbf678cb165>Building Parquet</a></li><li>3: <a
href=#pg-47cac26307c77b16f1b9e75c1e46efec>Contributing to Parquet [...]
-Java resources can be build using <code>mvn package</code>. The current stable
version should always be available from Maven Central.</p><p>C++ thrift
resources can be generated via make.</p><p>Thrift can be also code-genned into
any other thrift-supported language.</p></div><div class=td-content
style=page-break-before:always><h1 id=pg-47cac26307c77b16f1b9e75c1e46efec>3 -
Contributing to Parquet-Java</h1><div class=lead>How to contribute to
Parquet-Java</div><h2 id=pull-requests>Pull Re [...]
+Java resources can be build using <code>mvn package</code>. The current stable
version should always be available from Maven Central.</p><p>C++ thrift
resources can be generated via make.</p><p>Thrift can be also code-genned into
any other thrift-supported language.</p></div><div class=td-content
style=page-break-before:always><h1 id=pg-47cac26307c77b16f1b9e75c1e46efec>3 -
Contributing to Parquet-Java</h1><div class=lead>How to contribute to
Parquet-Java</div><h2 id=pull-requests>Pull Re [...]
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @param c the current class
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @return the corresponding logger
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @deprecated will be removed in 2.0.0;
use org.slf4j.LoggerFactory instead.
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> */</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#5c35cc;font-weight:700>@Deprecated</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>public</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>static</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>Log</span><span style=color:#f8f8f8;text-decoration:underline>
</span><span style=color:#000>getLog</span><span style=color:#000 [...]
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>return</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>new</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>Log</span><span style=color:#000;font-weight:700>(</span><span
style=color:#000>c</span><span style=color:#000;font-weight:700> [...]
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#000;font-weight:700>}</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span></code></pre></div><p>Checking for API violations can be
done by running <code>mvn verify -Dmaven.test.skip=true
japicmp:cmp</code>.</p><h3 id=tracking-issues-using-milestones>Tracking issues
using Milestones</h3><p>When a PR is raised that fixes a bug, or a feature that
you want to target a certain version, make sure to attach a <a
href=https://github.com/apache/parquet-java/milestones>milestone</a>. This way
other committers can track certain versions, and see what [...]
</span></span></code></pre></div><p>Now you can cherry-pick a PR to a previous
branch:</p><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-sh data-lang=sh><span style=display:flex><span>get fetch --all
</span></span><span style=display:flex><span>git checkout parquet-1.14.x
</span></span><span style=display:flex><span>git reset --hard
github-apache/parquet-1.14.x
diff --git a/output/docs/contribution-guidelines/contributing/index.html
b/output/docs/contribution-guidelines/contributing/index.html
index a4f8fd3..9e6f172 100644
--- a/output/docs/contribution-guidelines/contributing/index.html
+++ b/output/docs/contribution-guidelines/contributing/index.html
@@ -1,13 +1,22 @@
<!doctype html><html itemscope itemtype=http://schema.org/WebPage lang=en
class=no-js><head><meta charset=utf-8><meta name=viewport
content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=robots
content="index, follow"><link rel="shortcut icon"
href=/favicons/favicon.ico><link rel=apple-touch-icon
href=/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon
type=image/png href=/favicons/favicon-16x16.png sizes=16x16><link rel=icon
type=image/png href=/favicon [...]
<meta name=description content="How to contribute to Parquet-Java
"><meta property="og:title" content="Contributing to Parquet-Java"><meta
property="og:description" content="How to contribute to Parquet-Java
-"><meta property="og:type" content="article"><meta property="og:url"
content="/docs/contribution-guidelines/contributing/"><meta
property="article:section" content="docs"><meta
property="article:modified_time" content="2024-08-06T11:29:08+02:00"><meta
property="og:site_name" content="Apache Parquet"><meta itemprop=name
content="Contributing to Parquet-Java"><meta itemprop=description content="How
to contribute to Parquet-Java
-"><meta itemprop=dateModified content="2024-08-06T11:29:08+02:00"><meta
itemprop=wordCount content="591"><meta itemprop=keywords content><meta
name=twitter:card content="summary"><meta name=twitter:title
content="Contributing to Parquet-Java"><meta name=twitter:description
content="How to contribute to Parquet-Java
+"><meta property="og:type" content="article"><meta property="og:url"
content="/docs/contribution-guidelines/contributing/"><meta
property="article:section" content="docs"><meta
property="article:modified_time" content="2024-11-13T13:30:30+01:00"><meta
property="og:site_name" content="Apache Parquet"><meta itemprop=name
content="Contributing to Parquet-Java"><meta itemprop=description content="How
to contribute to Parquet-Java
+"><meta itemprop=dateModified content="2024-11-13T13:30:30+01:00"><meta
itemprop=wordCount content="736"><meta itemprop=keywords content><meta
name=twitter:card content="summary"><meta name=twitter:title
content="Contributing to Parquet-Java"><meta name=twitter:description
content="How to contribute to Parquet-Java
"><link rel=preload
href=/scss/main.min.7f095589dcf99af199766009c9a9719e6fdf2b9ce9bcfbeb05e80eb6efeaf32b.css
as=style><link
href=/scss/main.min.7f095589dcf99af199766009c9a9719e6fdf2b9ce9bcfbeb05e80eb6efeaf32b.css
rel=stylesheet integrity><script
src=https://code.jquery.com/jquery-3.6.3.min.js
integrity="sha512-STof4xm1wgkfm7heWqFJVn58Hm3EtS31XFaagaa8VMReCXAkQnJZ+jEy8PCC/iT18dFy95WcExNHFTqLyp72eQ=="
crossorigin=anonymous></script><link rel=stylesheet
href=https://cdn.jsdelivr.net/npm/@doc [...]
<a
href=https://github.com/apache/parquet-site/edit/production/content/en/docs/Contribution%20Guidelines/contributing.md
class="td-page-meta--edit td-page-meta__edit" target=_blank rel=noopener><i
class="fa-solid fa-pen-to-square fa-fw"></i> Edit this page</a>
<a
href="https://github.com/apache/parquet-site/new/production/content/en/docs/Contribution%20Guidelines?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+s
[...]
<a
href="https://github.com/apache/parquet-site/issues/new?title=Contributing%20to%20Parquet-Java";
class="td-page-meta--issue td-page-meta__issue" target=_blank rel=noopener><i
class="fa-solid fa-list-check fa-fw"></i> Create documentation issue</a>
-<a id=print href=/docs/contribution-guidelines/_print/><i class="fa-solid
fa-print fa-fw"></i> Print entire section</a></div><div class=td-toc><nav
id=TableOfContents><ul><li><a href=#pull-requests>Pull Requests</a></li><li><a
href=#committers>Committers</a><ul><li><a href=#merging-a-pull-request>Merging
a Pull Request</a></li><li><a href=#tracking-issues-using-milestones>Tracking
issues using Milestones</a></li><li><a href=#maintenance-branches>Maintenance
branches</a></li></ul></li><li [...]
+<a id=print href=/docs/contribution-guidelines/_print/><i class="fa-solid
fa-print fa-fw"></i> Print entire section</a></div><div class=td-toc><nav
id=TableOfContents><ul><li><a href=#pull-requests>Pull Requests</a></li><li><a
href=#committers>Committers</a><ul><li><a href=#merging-a-pull-request>Merging
a Pull Request</a></li><li><a href=#semantic-versioning>Semantic
versioning</a></li><li><a href=#tracking-issues-using-milestones>Tracking
issues using Milestones</a></li><li><a href=#ma [...]
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @param c the current class
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @return the corresponding logger
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> * @deprecated will be removed in 2.0.0;
use org.slf4j.LoggerFactory instead.
+</span></span></span><span style=display:flex><span><span
style=color:#8f5902;font-style:italic> */</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#5c35cc;font-weight:700>@Deprecated</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>public</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>static</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>Log</span><span style=color:#f8f8f8;text-decoration:underline>
</span><span style=color:#000>getLog</span><span style=color:#000 [...]
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>return</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>new</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>Log</span><span style=color:#000;font-weight:700>(</span><span
style=color:#000>c</span><span style=color:#000;font-weight:700> [...]
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#000;font-weight:700>}</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span></code></pre></div><p>Checking for API violations can be
done by running <code>mvn verify -Dmaven.test.skip=true
japicmp:cmp</code>.</p><h3 id=tracking-issues-using-milestones>Tracking issues
using Milestones</h3><p>When a PR is raised that fixes a bug, or a feature that
you want to target a certain version, make sure to attach a <a
href=https://github.com/apache/parquet-java/milestones>milestone</a>. This way
other committers can track certain versions, and see what [...]
</span></span></code></pre></div><p>Now you can cherry-pick a PR to a previous
branch:</p><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-sh data-lang=sh><span style=display:flex><span>get fetch --all
</span></span><span style=display:flex><span>git checkout parquet-1.14.x
</span></span><span style=display:flex><span>git reset --hard
github-apache/parquet-1.14.x
@@ -15,6 +24,6 @@
</span></span><span style=display:flex><span>git push
github-apache/parquet-1.14.x
</span></span></code></pre></div><h2 id=website>Website</h2><h3
id=release-documentation>Release Documentation</h3><p>To create documentation
for a new release of <code>parquet-format</code> create a new
<releasenumber>.md file under <code>content/en/blog/parquet-format</code>.
Please see existing files in that directory as an example.</p><p>To create
documentation for a new release of <code>parquet-java</code> create a new
<releasenumber>.md file under <code>content/en/blog/parquet-java [...]
job in the <a
href=https://github.com/apache/parquet-site/blob/staging/.github/workflows/deploy.yml>deployment
workflow</a> will be run, populating the <code>asf-staging</code> branch on
this repo with the necessary files.</li></ol><p><strong>Do not directly edit
the <code>asf-staging</code> branch of this repo</strong></p><h4
id=production>Production</h4><p>To make a change to the <code>production</code>
version of the website:</p><ol><li>Make a PR against the
<code>production</code> br [...]
-job in the <a
href=https://github.com/apache/parquet-site/blob/production/.github/workflows/deploy.yml>deployment
workflow</a> will be run, populating the <code>asf-site</code> branch on this
repo with the necessary files.</li></ol><p><strong>Do not directly edit the
<code>asf-site</code> branch of this repo</strong></p><div
class=td-page-meta__lastmod>Last modified August 6, 2024: <a
href=https://github.com/apache/parquet-site/commit/b37b1643ce2c05aab5d784d7c709bd6d9c840b3b>GH-80:
Updat [...]
+job in the <a
href=https://github.com/apache/parquet-site/blob/production/.github/workflows/deploy.yml>deployment
workflow</a> will be run, populating the <code>asf-site</code> branch on this
repo with the necessary files.</li></ol><p><strong>Do not directly edit the
<code>asf-site</code> branch of this repo</strong></p><div
class=td-page-meta__lastmod>Last modified November 13, 2024: <a
href=https://github.com/apache/parquet-site/commit/ee98419b8698b35a5c29d863b359909cf1eea0fe>GH-85:
Ad [...]
2024
<span class=td-footer__authors>Apache Parquet</span></span><span
class=td-footer__all_rights_reserved>All Rights Reserved</span><span
class=ms-2><a href=https://policies.google.com/privacy target=_blank
rel=noopener>Privacy Policy</a></span></div></div></div></footer></div><script
src=/js/main.min.26b35480299b932e285af8358c943de97509b95a0086d091584e7cb9b00c5c7b.js
integrity="sha256-JrNUgCmbky4oWvg1jJQ96XUJuVoAhtCRWE58ubAMXHs="
crossorigin=anonymous></script><script defer src=/js/click-to [...]
\ No newline at end of file
diff --git a/output/docs/contribution-guidelines/index.xml
b/output/docs/contribution-guidelines/index.xml
index eda59b5..26d39ad 100644
--- a/output/docs/contribution-guidelines/index.xml
+++ b/output/docs/contribution-guidelines/index.xml
@@ -24,6 +24,24 @@ Java resources can be build using <code>mvn
package</code>. The current st
<p>Merging a pull request requires being a committer on the project and
approval of the PR by a committer who is not the author.</p>
<p>A pull request can be merged through the GitHub UI. By default, only
<a
href="https://github.com/apache/parquet-java/blob/824b7d009eb41539cb0e2f73110efc0ac5694251/.asf.yaml#L29";>squash
and merge</a> is enabled on the project.</p>
<p>When the PR solves an existing issue, ensure that it references the
issue in the Pull-Request template <code>Closes #1234</code>. This way
the issue is linked to the PR, and GitHub will automatically close the relevant
issue when the PR is being merged.</p>
+<h3 id="semantic-versioning">Semantic versioning</h3>
+<p>Parquet-Java leverages <a
href="https://semver.org/#semantic-versioning-200";>semantic versioning</a>
to ensure compatibility for developers and users of the libraries as APIs and
implementations evolve. The Maven plugin <a
href="https://github.com/siom79/japicmp";><code>japicmp</code></a>
enforces this, and will fail when an API is being changed without going through
the correct deprecation cycle. This includes for all the modules, excluding:
<code>parquet-bench [...]
+<p>All interfaces, classes, and methods targeted for deprecation must
include the following:</p>
+<ul>
+<li><code>@Deprecated</code> annotation on the appropriate
element</li>
+<li><code>@depreceted</code> javadoc comment including: the version
for removal, the appropriate alternative for usage</li>
+<li>Replacement of existing code paths that use the deprecated
behavior</li>
+</ul>
+<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-java" data-lang="java"><span
style="display:flex;"><span><span
style="color:#8f5902;font-style:italic">/**
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> * @param c the current class
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> * @return the corresponding logger
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> * @deprecated will be removed in
2.0.0; use org.slf4j.LoggerFactory instead.
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> */</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#5c35cc;font-weight:bold">@Deprecated</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#204a87;font-weight:bold">public</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">static</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">Log</span><span
style="color:#f8f8f8;text-decoration:unde [...]
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">return</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">new</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">Log</span><span
style="color:#000;font-weight:bold">(</s [...]
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#000;font-weight:bold">}</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span></code></pre></div><p>Checking for
API violations can be done by running <code>mvn verify
-Dmaven.test.skip=true japicmp:cmp</code>.</p>
<h3 id="tracking-issues-using-milestones">Tracking issues using
Milestones</h3>
<p>When a PR is raised that fixes a bug, or a feature that you want to
target a certain version, make sure to attach a <a
href="https://github.com/apache/parquet-java/milestones";>milestone</a>. This
way other committers can track certain versions, and see what is still pending.
For information on the actual release, please check <a
href="/docs/contribution-guidelines/releasing/">the release page</a>.</p>
<h3 id="maintenance-branches">Maintenance branches</h3>
diff --git a/output/docs/index.xml b/output/docs/index.xml
index 1a1ae91..5767150 100644
--- a/output/docs/index.xml
+++ b/output/docs/index.xml
@@ -880,6 +880,24 @@ Java resources can be build using <code>mvn
package</code>. The current st
<p>Merging a pull request requires being a committer on the project and
approval of the PR by a committer who is not the author.</p>
<p>A pull request can be merged through the GitHub UI. By default, only
<a
href="https://github.com/apache/parquet-java/blob/824b7d009eb41539cb0e2f73110efc0ac5694251/.asf.yaml#L29";>squash
and merge</a> is enabled on the project.</p>
<p>When the PR solves an existing issue, ensure that it references the
issue in the Pull-Request template <code>Closes #1234</code>. This way
the issue is linked to the PR, and GitHub will automatically close the relevant
issue when the PR is being merged.</p>
+<h3 id="semantic-versioning">Semantic versioning</h3>
+<p>Parquet-Java leverages <a
href="https://semver.org/#semantic-versioning-200";>semantic versioning</a>
to ensure compatibility for developers and users of the libraries as APIs and
implementations evolve. The Maven plugin <a
href="https://github.com/siom79/japicmp";><code>japicmp</code></a>
enforces this, and will fail when an API is being changed without going through
the correct deprecation cycle. This includes for all the modules, excluding:
<code>parquet-bench [...]
+<p>All interfaces, classes, and methods targeted for deprecation must
include the following:</p>
+<ul>
+<li><code>@Deprecated</code> annotation on the appropriate
element</li>
+<li><code>@depreceted</code> javadoc comment including: the version
for removal, the appropriate alternative for usage</li>
+<li>Replacement of existing code paths that use the deprecated
behavior</li>
+</ul>
+<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-java" data-lang="java"><span
style="display:flex;"><span><span
style="color:#8f5902;font-style:italic">/**
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> * @param c the current class
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> * @return the corresponding logger
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> * @deprecated will be removed in
2.0.0; use org.slf4j.LoggerFactory instead.
+</span></span></span><span style="display:flex;"><span><span
style="color:#8f5902;font-style:italic"> */</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#5c35cc;font-weight:bold">@Deprecated</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#204a87;font-weight:bold">public</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">static</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">Log</span><span
style="color:#f8f8f8;text-decoration:unde [...]
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">return</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">new</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">Log</span><span
style="color:#000;font-weight:bold">(</s [...]
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#000;font-weight:bold">}</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span></code></pre></div><p>Checking for
API violations can be done by running <code>mvn verify
-Dmaven.test.skip=true japicmp:cmp</code>.</p>
<h3 id="tracking-issues-using-milestones">Tracking issues using
Milestones</h3>
<p>When a PR is raised that fixes a bug, or a feature that you want to
target a certain version, make sure to attach a <a
href="https://github.com/apache/parquet-java/milestones";>milestone</a>. This
way other committers can track certain versions, and see what is still pending.
For information on the actual release, please check <a
href="/docs/contribution-guidelines/releasing/">the release page</a>.</p>
<h3 id="maintenance-branches">Maintenance branches</h3>
diff --git a/output/sitemap.xml b/output/sitemap.xml
index c850cca..45f5b10 100644
--- a/output/sitemap.xml
+++ b/output/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9";
xmlns:xhtml="http://www.w3.org/1999/xhtml";><url><loc>/docs/file-format/data-pages/compression/</loc><lastmod>2024-03-11T22:11:10+01:00</lastmod></url><url><loc>/docs/file-format/data-pages/encodings/</loc><lastmod>2024-03-11T22:11:10+01:00</lastmod></url><url><loc>/docs/file-format/data-pages/encryption/</loc><lastmod>2024-03-11T22:11:10+01:00</lastmod></url><url><loc>/docs/
[...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9";
xmlns:xhtml="http://www.w3.org/1999/xhtml";><url><loc>/docs/file-format/data-pages/compression/</loc><lastmod>2024-03-11T22:11:10+01:00</lastmod></url><url><loc>/docs/file-format/data-pages/encodings/</loc><lastmod>2024-03-11T22:11:10+01:00</lastmod></url><url><loc>/docs/file-format/data-pages/encryption/</loc><lastmod>2024-03-11T22:11:10+01:00</lastmod></url><url><loc>/docs/
[...]
\ No newline at end of file
