You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by as...@apache.org on 2022/11/12 01:58:58 UTC
[calcite-site] branch main updated: Website deployed from calcite@7277e53adea98e7dd8477d5a47e728aca6d8f680
This is an automated email from the ASF dual-hosted git repository.
asf-ci-deploy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/calcite-site.git
The following commit(s) were added to refs/heads/main by this push:
new eb33ff4a Website deployed from calcite@7277e53adea98e7dd8477d5a47e728aca6d8f680
eb33ff4a is described below
commit eb33ff4a1c60e778b5cf54b8f653e761094ab6c1
Author: F21 <F2...@users.noreply.github.com>
AuthorDate: Sat Nov 12 01:58:53 2022 +0000
Website deployed from calcite@7277e53adea98e7dd8477d5a47e728aca6d8f680
---
develop/index.html | 64 +++++++++++++++++++++++++++++++++++----
docs/howto.html | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 146 insertions(+), 5 deletions(-)
diff --git a/develop/index.html b/develop/index.html
index bc18f2bd..b8e4713d 100644
--- a/develop/index.html
+++ b/develop/index.html
@@ -65,9 +65,15 @@
<ul id="markdown-toc">
<li><a href="#source-code" id="markdown-toc-source-code">Source code</a></li>
<li><a href="#download-source-build-and-run-tests" id="markdown-toc-download-source-build-and-run-tests">Download source, build, and run tests</a></li>
+ <li>
+<a href="#jira-accounts" id="markdown-toc-jira-accounts">JIRA accounts</a> <ul>
+ <li><a href="#i-already-have-an-asf-jira-account-and-want-to-be-added-as-a-contributor" id="markdown-toc-i-already-have-an-asf-jira-account-and-want-to-be-added-as-a-contributor">I already have an ASF JIRA account and want to be added as a contributor</a></li>
+ <li><a href="#i-do-not-have-an-asf-jira-account-want-to-request-an-account-and-be-added-as-a-contributor" id="markdown-toc-i-do-not-have-an-asf-jira-account-want-to-request-an-account-and-be-added-as-a-contributor">I do not have an ASF JIRA account, want to request an account and be added as a contributor</a></li>
+ </ul>
+ </li>
<li><a href="#contributing" id="markdown-toc-contributing">Contributing</a></li>
<li><a href="#null-safety" id="markdown-toc-null-safety">Null safety</a></li>
- <li><a href="#continuous-integration-testing" id="markdown-toc-continuous-integration-testing">Continuous Integration Testing</a></li>
+ <li><a href="#continuous-integration-testing" id="markdown-toc-continuous-integration-testing">Continuous integration testing</a></li>
<li><a href="#getting-started" id="markdown-toc-getting-started">Getting started</a></li>
</ul>
@@ -108,6 +114,54 @@ then build using Gradle:</p>
<a href="/docs/howto.html#running-tests">run more or fewer tests</a> and
<a href="/docs/howto.html#running-integration-tests">run integration tests</a>.</p>
+<h2 id="jira-accounts">JIRA accounts</h2>
+<p>Calcite uses <a href="https://issues.apache.org/jira/browse/CALCITE">JIRA</a> for issues/case management.
+You must have a JIRA account in order to log cases and issues.</p>
+
+<h3 id="i-already-have-an-asf-jira-account-and-want-to-be-added-as-a-contributor">I already have an ASF JIRA account and want to be added as a contributor</h3>
+<p>If you already have an ASF JIRA account, you do not need to sign up for a
+new account. Please email <a href="mailto:jira-requests@calcite.apache.org">jira-requests@calcite.apache.org</a>
+using the following template, so that we can add your account to the
+contributors list in JIRA:</p>
+
+<p><a href="mailto:jira-requests@calcite.apache.org?subject=Add%20me%20as%20a%20contributor%20to%20JIRA&body=Hello,%0A%0APlease%20add%20me%20as%20a%20contributor%20to%20JIRA.%0AMy%20JIRA%20username%20is:%20%5BINSERT%20YOUR%20JIRA%20USERNAME%20HERE%5D%0A%0AThanks,%0A%5BINSERT%20YOUR%20NAME%20HERE%5D"><strong>[Open the template in your email client]</strong></a></p>
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Subject: Add me as a contributor to JIRA
+
+Hello,
+
+Please add me as a contributor to JIRA.
+My JIRA username is: [INSERT YOUR JIRA USERNAME HERE]
+
+Thanks,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+<h3 id="i-do-not-have-an-asf-jira-account-want-to-request-an-account-and-be-added-as-a-contributor">I do not have an ASF JIRA account, want to request an account and be added as a contributor</h3>
+<p>In order to request an ASF JIRA account, you will need to email
+<a href="mailto:jira-requests@calcite.apache.org">jira-requests@calcite.apache.org</a>
+using the following template:</p>
+
+<p><a href="mailto:jira-requests@calcite.apache.org?subject=Request%20for%20JIRA%20Account&body=Hello,%0A%0AI%20would%20like%20to%20request%20a%20JIRA%20account.%0AMy%20proposed%20JIRA%20username:%20%5BINSERT%20YOUR%20DESIRED%20JIRA%20USERNAME%20HERE%20(LOWERCASE%20LETTERS%20AND%20NUMBERS%20ONLY)%5D%0AMy%20full%20name:%20%5BINSERT%20YOUR%20FULL%20NAME%20HERE%5D%0AMy%20email%20address:%20%5BINSERT%20YOUR%20EMAIL%20ADDRESS%20HERE%5D%0A%0AThanks,%0A%5BINSERT%20YOUR%20NAME%20HERE%5D"><st [...]
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Subject: Request for JIRA Account
+
+Hello,
+
+I would like to request a JIRA account.
+My proposed JIRA username: [INSERT YOUR DESIRED JIRA USERNAME HERE (LOWERCASE LETTERS AND NUMBERS ONLY)]
+My full name: [INSERT YOUR FULL NAME HERE]
+My email address: [INSERT YOUR EMAIL ADDRESS HERE]
+
+Thanks,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+<p><strong>IMPORTANT</strong>: The email address the request is sent from MUST be the same
+as the email address in the body of the request, otherwise, we will not be
+able to process your request.</p>
+
+<p>Once the ASF has processed our submission on your behalf, you will receive
+an email to set your password.</p>
+
<h2 id="contributing">Contributing</h2>
<p>We welcome contributions.</p>
@@ -131,7 +185,7 @@ summary line. If you remove information while clarifying, put it in
the description of the case.</p>
<p>Design discussions may happen in various places (email threads,
-github reviews) but the JIRA case is the canonical place for those
+Github reviews) but the JIRA case is the canonical place for those
discussions. Link to them or summarize them in the case.</p>
<p>When implementing a case, especially a new feature, make sure
@@ -155,8 +209,8 @@ feel free to tag the respective contributor(s) in the discussion.</p>
<p>If you are going to take on the issue right away assign it to yourself.
To assign issues to yourself you have to be registered in JIRA as a contributor.
-In order to do that, send an email to the developers list
-and provide your JIRA username.</p>
+In order to do that, please follow the instructions outlined in the
+<a href="#jira-accounts">JIRA Accounts</a> section.</p>
<p>If you are committed to fixing the issue before the upcoming release set
the fix version accordingly (e.g., 1.20.0), otherwise leave it as blank.</p>
@@ -380,7 +434,7 @@ then it is the same as <code class="language-plaintext highlighter-rouge"><T
</li>
</ul>
-<h2 id="continuous-integration-testing">Continuous Integration Testing</h2>
+<h2 id="continuous-integration-testing">Continuous integration testing</h2>
<p>Calcite exploits <a href="https://github.com/apache/calcite/actions?query=branch%3Amain">GitHub actions</a>
and <a href="https://app.travis-ci.com/github/apache/calcite">Travis</a> for continuous integration testing.
diff --git a/docs/howto.html b/docs/howto.html
index ffd999d8..f0fc1d05 100644
--- a/docs/howto.html
+++ b/docs/howto.html
@@ -141,6 +141,19 @@ adapters.</p>
<li><a href="#publish-the-web-site" id="markdown-toc-publish-the-web-site">Publishing the web site</a></li>
</ul>
</li>
+ <li>
+<a href="#advanced-topics-for-pmc-members" id="markdown-toc-advanced-topics-for-pmc-members">Advanced topics for PMC members</a> <ul>
+ <li>
+<a href="#processing-jira-account-requests" id="markdown-toc-processing-jira-account-requests">Processing JIRA account requests</a> <ul>
+ <li><a href="#account-added-to-contributor-list" id="markdown-toc-account-added-to-contributor-list">Account added to contributor list</a></li>
+ <li><a href="#account-not-found" id="markdown-toc-account-not-found">Account not found</a></li>
+ <li><a href="#jira-account-created-and-added-to-contributors-list" id="markdown-toc-jira-account-created-and-added-to-contributors-list">JIRA account created and added to contributors list</a></li>
+ <li><a href="#jira-username-unavailable" id="markdown-toc-jira-username-unavailable">JIRA username unavailable</a></li>
+ <li><a href="#request-not-sent-from-same-email-address-for-jira-account" id="markdown-toc-request-not-sent-from-same-email-address-for-jira-account">Request not sent from same email address for JIRA account</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
</ul>
<h2 id="building-from-a-source-distribution">Building from a source distribution</h2>
@@ -1141,6 +1154,80 @@ that <code class="language-plaintext highlighter-rouge">main</code> code freeze
<p>See instructions in
<a href="https://github.com/apache/calcite/blob/main/site/README.md">site/README.md</a>.</p>
+<h1 id="advanced-topics-for-pmc-members">Advanced topics for PMC members</h1>
+
+<h2 id="processing-jira-account-requests">Processing JIRA account requests</h2>
+<p>Here are some email templates that can be used when processing requests for JIRA accounts.</p>
+
+<h3 id="account-added-to-contributor-list">Account added to contributor list</h3>
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! I have added your username ([INSERT USERNAME HERE])
+to the contributors group in JIRA. Happy contributing!
+
+If you have not subscribed to our development list (dev@calcite.apache.org) yet, I encourage you to do so by
+emailing dev-subscribe@calcite.apache.org. Further information about our mailing lists is available here:
+https://calcite.apache.org/community/#mailing-lists
+
+Best regards,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+<h3 id="account-not-found">Account not found</h3>
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! I am sorry to inform you that I was unable to
+find your account ([INSERT USERNAME HERE]) in JIRA and was not able to add you to the contributors group.
+Please let me know the correct username by return email and I will process your request again.
+
+If you do not have an ASF JIRA account, please follow the instructions here to request one:
+https://calcite.apache.org/develop/#i-do-not-have-an-asf-jira-account-want-to-request-an-account-and-be-added-as-a-contributor
+
+Best regards,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+<h3 id="jira-account-created-and-added-to-contributors-list">JIRA account created and added to contributors list</h3>
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! I have requested for your JIRA account
+with the username ([INSERT USERNAME HERE]) to be created. You will receive an email shortly with further
+instructions on how to set your password. I have also added your account to the contributors list in JIRA.
+Happy contributing!
+
+If you have not subscribed to our development list (dev@calcite.apache.org) yet, I encourage you to do so by
+emailing dev-subscribe@calcite.apache.org. Further information about our mailing lists is available here:
+https://calcite.apache.org/community/#mailing-lists
+
+Best regards,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+<h3 id="jira-username-unavailable">JIRA username unavailable</h3>
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! Unfortunately, the username you requested
+([INSERT USERNAME HERE]) is not available. Please note that usernames can only contain lowercase
+letters and numbers. Please select a different username and let me know by return email to try again.
+
+Best regards,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+<h3 id="request-not-sent-from-same-email-address-for-jira-account">Request not sent from same email address for JIRA account</h3>
+
+<figure class="highlight"><pre><code class="language-text" data-lang="text">Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! Unfortunately, I am unable to process your
+request as the request was not sent from the email address to be linked to your JIRA account.
+
+Please send your request again using the same email address as the one requested for your account ([INSERT EMAIL ADDRESS HERE]),
+so that I can process your request.
+
+Best regards,
+[INSERT YOUR NAME HERE]</code></pre></figure>
+
+