You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by gi...@apache.org on 2022/07/27 17:52:56 UTC
[iceberg-docs] branch asf-site updated: deploy: 4d9facf128a9f37477f7d0e63249f808f53be3a0
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/iceberg-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new d3aca40d deploy: 4d9facf128a9f37477f7d0e63249f808f53be3a0
d3aca40d is described below
commit d3aca40db091d28fff9a229746f1a14214abbaf6
Author: rdblue <rd...@users.noreply.github.com>
AuthorDate: Wed Jul 27 17:52:51 2022 +0000
deploy: 4d9facf128a9f37477f7d0e63249f808f53be3a0
---
community/index.html | 5 +----
contribute/index.html | 45 ++++++++++++---------------------------------
getting-started/index.html | 20 +-------------------
search.json | 2 +-
4 files changed, 15 insertions(+), 57 deletions(-)
diff --git a/community/index.html b/community/index.html
index 3284750e..6174be59 100644
--- a/community/index.html
+++ b/community/index.html
@@ -3,10 +3,7 @@
<span class=icon-bar></span>
<span class=icon-bar></span>
<span class=icon-bar></span></button>
-<a class="page-scroll navbar-brand" href=https://iceberg.apache.org/><img class=top-navbar-logo src=https://iceberg.apache.org//img/iceberg-logo-icon.png> Apache Iceberg</a></div><div><input type=search class=form-control id=search-input placeholder=Search... maxlength=64 data-hotkeys=s/></div><div class=versions-dropdown><span>0.14.0</span> <i class="fa fa-chevron-down"></i><div class=versions-dropdown-content><ul><li class=versions-dropdown-selection><a href=/docs/latest>latest</a></li [...]
-Point to <a href=https://github.com/apache/iceberg/blob/master/.baseline/idea/intellij-java-palantir-style.xml>intellij-java-palantir-style.xml</a> and hit <strong>OK</strong> (you might need to enable <strong>Show Hidden Files and Directories</strong> in the dialog). The code itself can then be formatted via <strong>Code > Reformat Code</strong>.</p><p>See also the IntelliJ <a href=https://www.jetbrains.com/help/idea/copying-code-style-settings.html>Code Style docs</a> and <a href=https [...]
-no “push a single button to get a performance comparison” solution available, therefore one has to run JMH performance tests on their local machine and
-post the results on the PR.</p><p>See <a href=../benchmarks>Benchmarks</a> for a summary of available benchmarks and how to run them.</p></div><div id=toc class=markdown-body><div id=full><nav id=TableOfContents><ul><li><a href=#contribute>Contribute</a></li><li><a href=#issues>Issues</a></li><li><a href=#slack>Slack</a></li><li><a href=#mailing-lists>Mailing Lists</a></li><li><a href=#setting-up-ide-and-code-style>Setting up IDE and Code Style</a><ul><li><a href=#configuring-code-format [...]
+<a class="page-scroll navbar-brand" href=https://iceberg.apache.org/><img class=top-navbar-logo src=https://iceberg.apache.org//img/iceberg-logo-icon.png> Apache Iceberg</a></div><div><input type=search class=form-control id=search-input placeholder=Search... maxlength=64 data-hotkeys=s/></div><div class=versions-dropdown><span>0.14.0</span> <i class="fa fa-chevron-down"></i><div class=versions-dropdown-content><ul><li class=versions-dropdown-selection><a href=/docs/latest>latest</a></li [...]
<script src=https://iceberg.apache.org//js/jquery.easing.min.js></script>
<script type=text/javascript src=https://iceberg.apache.org//js/search.js></script>
<script src=https://iceberg.apache.org//js/bootstrap.min.js></script>
diff --git a/contribute/index.html b/contribute/index.html
index b6188c39..e2f85e1c 100644
--- a/contribute/index.html
+++ b/contribute/index.html
@@ -8,9 +8,11 @@ these are hard rules and they’re meant as a collection of helpful suggesti
experience as possible.</p><p>If you are thinking of contributing but first would like to discuss the change you wish to make, we welcome you to
head over to the <a href=https://iceberg.apache.org/community/>Community</a> page on the official Iceberg documentation site
to find a number of ways to connect with the community, including slack and our mailing lists. Of course, always feel
-free to just open a <a href=https://github.com/apache/iceberg/issues/new>new issue</a> in the GitHub repo.</p><p>The Iceberg Project is hosted on GitHub at <a href=https://github.com/apache/iceberg>https://github.com/apache/iceberg</a>.</p><h2 id=pull-request-process>Pull Request Process</h2><p>The Iceberg community prefers to receive contributions as <a href=https://help.github.com/articles/about-pull-requests/>Github pull requests</a>.</p><p><a href=https://github.com/apache/iceberg/pu [...]
-Point to <a href=https://github.com/apache/iceberg/blob/master/.baseline/idea/intellij-java-palantir-style.xml>intellij-java-palantir-style.xml</a> and hit <strong>OK</strong> (you might need to enable <strong>Show Hidden Files and Directories</strong> in the dialog). The code itself can then be formatted via <strong>Code > Reformat Code</strong>.</p><p>See also the IntelliJ <a href=https://www.jetbrains.com/help/idea/copying-code-style-settings.html>Code Style docs</a> and <a href=https [...]
-adding a Copyright profile:</p><ol><li><p>In the <strong>Settings/Preferences</strong> dialog go to <strong>Editor → Copyright → Copyright Profiles</strong>.</p></li><li><p>Add a new profile and name it <strong>Apache</strong>.</p></li><li><p>Add the following text as the license text:</p><pre tabindex=0><code>Licensed to the Apache Software Foundation (ASF) under one
+free to just open a <a href=https://github.com/apache/iceberg/issues/new>new issue</a> in the GitHub repo.</p><p>The Iceberg Project is hosted on GitHub at <a href=https://github.com/apache/iceberg>https://github.com/apache/iceberg</a>.</p><h2 id=pull-request-process>Pull Request Process</h2><p>The Iceberg community prefers to receive contributions as <a href=https://help.github.com/articles/about-pull-requests/>Github pull requests</a>.</p><p><a href=https://github.com/apache/iceberg/pu [...]
+<a href=https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides>IntelliJ</a> to install the <strong>google-java-format</strong> plugin (note the required manual actions for IntelliJ).</p><h2 id=iceberg-code-contribution-guidelines>Iceberg Code Contribution Guidelines</h2><h3 id=style>Style</h3><p>For Python, please use the tox command <code>tox -e format</code> to apply autoformatting to the project.</p><p>Java code adheres to the <a href=https://goo [...]
+In order to automatically fix Java code style issues, please use <code>./gradlew spotlessApply</code>.</p><p><strong>NOTE</strong>: The <strong>google-java-format</strong> plugin will always use the latest version of the <strong>google-java-format</strong>. However, <code>spotless</code> itself is configured to use <strong>google-java-format</strong> 1.7
+since that version is compatible with JDK 8. When formatting the code in the IDE, there is a slight chance that it will produce slightly different results. In such a case please run <code>./gradlew spotlessApply</code>
+as CI will check the style against <strong>google-java-format</strong> 1.7.</p><h3 id=copyright>Copyright</h3><p>Each file must include the Apache license information as a header.</p><pre tabindex=0><code>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
@@ -18,7 +20,7 @@ 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
+ 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
@@ -26,10 +28,8 @@ software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-</code></pre></li><li><p>Go to <strong>Editor → Copyright</strong> and choose the <strong>Apache</strong> profile as the default profile for this
-project.</p></li><li><p>Click <strong>Apply</strong>.</p></li></ol><h2 id=iceberg-code-contribution-guidelines>Iceberg Code Contribution Guidelines</h2><h3 id=style>Style</h3><p>For Java styling, check out the section
-<a href=https://iceberg.apache.org/community/#setting-up-ide-and-code-style>Setting up IDE and Code Style</a> from the
-documentation site.</p><p>For Python, please use the tox command <code>tox -e format</code> to apply autoformatting to the project.</p><h3 id=copyright>Copyright</h3><p>Each file must include the Apache license information as a header.</p><pre tabindex=0><code>Licensed to the Apache Software Foundation (ASF) under one
+</code></pre><h3 id=configuring-copyright-for-intellij-idea>Configuring Copyright for IntelliJ IDEA</h3><p>Every file needs to include the Apache license as a header. This can be automated in IntelliJ by
+adding a Copyright profile:</p><ol><li><p>In the <strong>Settings/Preferences</strong> dialog go to <strong>Editor → Copyright → Copyright Profiles</strong>.</p></li><li><p>Add a new profile and name it <strong>Apache</strong>.</p></li><li><p>Add the following text as the license text:</p><pre tabindex=0><code>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
@@ -37,7 +37,7 @@ 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
+ 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
@@ -45,29 +45,8 @@ software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-</code></pre><h3 id=java-style-guidelines>Java style guidelines</h3><h4 id=line-breaks>Line breaks</h4><p>Continuation indents are 2 indents (4 spaces) from the start of the previous line.</p><p>Try to break long lines at the same semantic level to make code more readable.</p><ul><li>Don’t use the same level of indentation for arguments to different methods</li><li>Don’t use the same level of indentation for arguments and chained methods</li></ul><div class=highlight><pre tab [...]
-</span></span></span><span style=display:flex><span><span style=color:#75715e></span> doSomething<span style=color:#f92672>(</span><span style=color:#66d9ef>new</span> ArgumentClass<span style=color:#f92672>(</span>1<span style=color:#f92672>,</span>
-</span></span><span style=display:flex><span> 2<span style=color:#f92672>),</span>
-</span></span><span style=display:flex><span> 3<span style=color:#f92672>);</span>
-</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span> <span style=color:#75715e>// GOOD: break lines at the same semantic level
-</span></span></span><span style=display:flex><span><span style=color:#75715e></span> doSomething<span style=color:#f92672>(</span>
-</span></span><span style=display:flex><span> <span style=color:#66d9ef>new</span> ArgumentClass<span style=color:#f92672>(</span>1<span style=color:#f92672>,</span> 2<span style=color:#f92672>),</span>
-</span></span><span style=display:flex><span> 3<span style=color:#f92672>);</span>
-</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span> <span style=color:#75715e>// BAD: arguments and chained methods mixed
-</span></span></span><span style=display:flex><span><span style=color:#75715e></span> SomeObject myNewObject <span style=color:#f92672>=</span> SomeObject<span style=color:#f92672>.</span><span style=color:#a6e22e>builder</span><span style=color:#f92672>(</span>schema<span style=color:#f92672>,</span> partitionSpec<span style=color:#f92672>,</span>
-</span></span><span style=display:flex><span> sortOrder<span style=color:#f92672>)</span>
-</span></span><span style=display:flex><span> <span style=color:#f92672>.</span><span style=color:#a6e22e>withProperty</span><span style=color:#f92672>(</span><span style=color:#e6db74>"x"</span><span style=color:#f92672>,</span> <span style=color:#e6db74>"1"</span><span style=color:#f92672>)</span>
-</span></span><span style=display:flex><span> <span style=color:#f92672>.</span><span style=color:#a6e22e>build</span><span style=color:#f92672>()</span>
-</span></span><span style=display:flex><span>
-</span></span><span style=display:flex><span> <span style=color:#75715e>// GOOD: method calls at the same level, arguments indented
-</span></span></span><span style=display:flex><span><span style=color:#75715e></span> SomeObject myNewObject <span style=color:#f92672>=</span> SomeObject
-</span></span><span style=display:flex><span> <span style=color:#f92672>.</span><span style=color:#a6e22e>builder</span><span style=color:#f92672>(</span>schema<span style=color:#f92672>,</span> partitionSpec<span style=color:#f92672>,</span>
-</span></span><span style=display:flex><span> sortOrder<span style=color:#f92672>)</span>
-</span></span><span style=display:flex><span> <span style=color:#f92672>.</span><span style=color:#a6e22e>withProperty</span><span style=color:#f92672>(</span><span style=color:#e6db74>"x"</span><span style=color:#f92672>,</span> <span style=color:#e6db74>"1"</span><span style=color:#f92672>)</span>
-</span></span><span style=display:flex><span> <span style=color:#f92672>.</span><span style=color:#a6e22e>build</span><span style=color:#f92672>()</span>
-</span></span></code></pre></div><h4 id=method-naming>Method naming</h4><ol><li>Make method names as short as possible, while being clear. Omit needless words.</li><li>Avoid <code>get</code> in method names, unless an object must be a Java bean.<ul><li>In most cases, replace <code>get</code> with a more specific verb that describes what is happening in the method, like <code>find</code> or <code>fetch</code>.</li><li>If there isn’t a more specific verb or the method is a getter, om [...]
+</code></pre></li><li><p>Go to <strong>Editor → Copyright</strong> and choose the <strong>Apache</strong> profile as the default profile for this
+project.</p></li><li><p>Click <strong>Apply</strong>.</p></li></ol><h3 id=java-style-guidelines>Java style guidelines</h3><h4 id=method-naming>Method naming</h4><ol><li>Make method names as short as possible, while being clear. Omit needless words.</li><li>Avoid <code>get</code> in method names, unless an object must be a Java bean.<ul><li>In most cases, replace <code>get</code> with a more specific verb that describes what is happening in the method, like <code>find</code> or <code>fetc [...]
</span></span></span><span style=display:flex><span><span style=color:#75715e></span> <span style=color:#66d9ef>public</span> <span style=color:#66d9ef>void</span> <span style=color:#a6e22e>sendMessageIgnoreFailure</span><span style=color:#f92672>()</span> <span style=color:#f92672>{</span>
</span></span><span style=display:flex><span> sendMessageInternal<span style=color:#f92672>(</span><span style=color:#66d9ef>true</span><span style=color:#f92672>);</span>
</span></span><span style=display:flex><span> <span style=color:#f92672>}</span>
@@ -100,7 +79,7 @@ The GitHub Issues feature of the <a href=https://github.com/apache/iceberg-docs>
</span></span><span style=display:flex><span>rm -rf landing-page/content/common
</span></span><span style=display:flex><span>cp -r <path to iceberg repo>/docs/versioned docs/content/docs
</span></span><span style=display:flex><span>cp -r <path to iceberg repo>/docs/common landing-page/content/common
-</span></span></code></pre></div></div><div id=toc class=markdown-body><div id=full><nav id=TableOfContents><ul><li><a href=#pull-request-process>Pull Request Process</a></li><li><a href=#building-the-project-locally>Building the Project Locally</a></li><li><a href=#setting-up-ide-and-code-style>Setting up IDE and Code Style</a><ul><li><a href=#configuring-code-formatter-for-intellij-idea>Configuring Code Formatter for IntelliJ IDEA</a></li><li><a href=#configuring-copyright-for-intellij [...]
+</span></span></code></pre></div></div><div id=toc class=markdown-body><div id=full><nav id=TableOfContents><ul><li><a href=#pull-request-process>Pull Request Process</a></li><li><a href=#building-the-project-locally>Building the Project Locally</a></li><li><a href=#setting-up-ide-and-code-style>Setting up IDE and Code Style</a><ul><li><a href=#configuring-code-formatter-for-eclipseintellij>Configuring Code Formatter for Eclipse/IntelliJ</a></li></ul></li><li><a href=#iceberg-code-contri [...]
<script src=https://iceberg.apache.org//js/jquery.easing.min.js></script>
<script type=text/javascript src=https://iceberg.apache.org//js/search.js></script>
<script src=https://iceberg.apache.org//js/bootstrap.min.js></script>
diff --git a/getting-started/index.html b/getting-started/index.html
index b3c6e0d8..52cc0335 100644
--- a/getting-started/index.html
+++ b/getting-started/index.html
@@ -1,19 +1 @@
-<!--
- - 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.
- -->
-<head>
- <meta http-equiv="Refresh" content="0; url='/docs/latest/getting-started'" />
-</head>
+<!doctype html><html lang=en-us><head><title>https://iceberg.apache.org/spark-quickstart/</title><link rel=canonical href=https://iceberg.apache.org/spark-quickstart/><meta name=robots content="noindex"><meta charset=utf-8><meta http-equiv=refresh content="0; url=https://iceberg.apache.org/spark-quickstart/"></head></html>
\ No newline at end of file
diff --git a/search.json b/search.json
index 435be8e5..3e491d47 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"categories":null,"content":" Spark and Iceberg Quickstart This guide will get you up and running with an Iceberg and Spark environment, including sample code to highlight some powerful features. You can learn more about Iceberg’s Spark runtime by checking out the Spark section.\nDocker-Compose Creating a table Writing Data to a Table Reading Data from a Table Adding A Catalog Next Steps Docker-Compose The fastest way to get started is to use a docker-compose file that uses the the tab [...]
\ No newline at end of file
+[{"categories":null,"content":" Spark and Iceberg Quickstart This guide will get you up and running with an Iceberg and Spark environment, including sample code to highlight some powerful features. You can learn more about Iceberg’s Spark runtime by checking out the Spark section.\nDocker-Compose Creating a table Writing Data to a Table Reading Data from a Table Adding A Catalog Next Steps Docker-Compose The fastest way to get started is to use a docker-compose file that uses the the tab [...]
\ No newline at end of file