This is an automated email from the ASF dual-hosted git repository.
radu pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/sling-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 61702f5 SLING-7940 - Improve the Apache Sling website Contributing
page
61702f5 is described below
commit 61702f536cc84a39c8018d0f36f6602ddcf439da
Author: Radu Cotescu <[email protected]>
AuthorDate: Mon Sep 24 15:32:07 2018 +0200
SLING-7940 - Improve the Apache Sling website Contributing page
---
contributing.html | 26 +++++++++++++++--------
documentation/development/release-management.html | 13 ++++++++++--
2 files changed, 28 insertions(+), 11 deletions(-)
diff --git a/contributing.html b/contributing.html
index 7bf79b3..5aa27ff 100644
--- a/contributing.html
+++ b/contributing.html
@@ -87,17 +87,25 @@
</div><h1 class="pagetitle">
Contributing
</h1><div id="generatedToC"></div><script
src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script
src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script
type='text/javascript'>$(document).ready(function() {
$('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script>
-<div class="row"><div class="small-12 columns"><section class="wrap"><p>See <a
href="/project-information.html">Project Information</a> for details about the
tools mentioned below.</p>
-<p>Apache Sling is a volunteer effort, so there is always plenty of work that
needs to be accomplished. If you want to help support Sling, this page is
intended as a starting point for specific contribution ideas. To further
understand how the Sling community operates, refer to the Community Roles and
Processes document and/or join the mailing lists.</p>
-<p>The Sling project organizes its "to do" list using the JIRA issue tracking
system. Specific items from Sling's JIRA issue tracking system are highlighted
on this page, but are not limited to it. The purpose of the list here is to
highlight issues that are either more important or serve as good entry points
for new contributors.</p>
-<p>It is important to point out that you do not need to be a programmer to
contribute to Sling. As such, we will break out the list of issues below for
non-programmers and programmers.</p>
-<h2><a href="#non-programmers" name="non-programmers">Non-Programmers</a></h2>
-<p>Improve web site or documentation (e.g., create/propose FAQ entries). There
is no specific JIRA issue for this task, but any contributions could be posted
as new JIRA issues for the Documentation component.</p>
-<h2><a href="#programmers" name="programmers">Programmers</a></h2>
-<p>Implement support for various rendering technologies in Sling. Examples
coming to mind are JSF and Wicket.</p></section></div></div>
+<div class="row"><div class="small-12 columns"><section class="wrap"><p>Thanks
for choosing to contribute to Apache Sling! The following are a set of
guidelines to follow when contributing to this project.</p>
+<h2><a href="#code-of-conduct" name="code-of-conduct">Code of Conduct</a></h2>
+<p>Being an Apache project, Apache Sling adheres to the Apache Software
Foundation's <a
href="https://www.apache.org/foundation/policies/conduct.html";>Code of
Conduct</a>.</p>
+<h2><a href="#legal" name="legal">Legal</a></h2>
+<p>Before contributing to the project, please make sure you understand the <a
href="https://www.apache.org/foundation/how-it-works/legal.html";>requirements
and implications of contributing to the Apache Software Foundation</a>. An <a
href="https://www.apache.org/licenses/icla.pdf";>Apache iCLA</a> is welcome if
you start contributing regularly, and required if you later become a
committer.</p>
+<h2><a href="#how-to-contribute" name="how-to-contribute">How to
contribute</a></h2>
+<p>Apache Sling is a volunteer effort, so there is always plenty of work that
needs to be accomplished. If you want to help supporting Apache Sling, this
page is intended as a starting point for specific contribution ideas. To
further understand how the Sling community operates, refer to the <a
href="https://www.apache.org/foundation/how-it-works.html";>Community Roles and
Processes document</a> and/or join our mailing lists.</p>
+<p>See <a href="/project-information.html">Project Information</a> for details
about the tools mentioned below.</p>
+<p>The Apache Sling project organizes its "to do" list using the Apache <a
href="https://issues.apache.org/jira/browse/SLING";>JIRA issue tracking
system</a>. No matter if you are a programmer or not, it is probably best to
check JIRA first to figure out if the problem you identified is already known.
If not, please create a JIRA issue in which you try to describe to the best of
your knowledge the bug that you want to fix or the improvement that you would
like to contribute. There are man [...]
+<p>If pull requests are familiar to you, the next step is to open one against
one of our modules. More details about how the project is structured in terms
of repositories can be read on the <a
href="/documentation/development/getting-and-building-sling.html">Getting and
Building Sling</a> page.</p>
+<p>For relatively large contributions (e.g. new modules), we recommend one of
the following two approaches:</p>
+<ol>
+ <li>open a JIRA issue and send a pull request to the <a
href="https://github.com/apache/sling-whiteboard/";>Apache Sling Whiteboard
project</a></li>
+ <li>open a JIRA issue and attach your source code to it as a zip or tar
archive.</li>
+</ol>
+<p>For people who are completely new to contributing to an Apache Software
Foundation project, the <a
href="https://www.apache.org/foundation/getinvolved.html";>Get Involved</a> page
provides you with enough resources to understand how the foundation works and
how its projects are structured - and don't hesitate to ask on our <a
href="http://sling.apache.org/project-information.html#mailing-lists";>mailing
lists</a>!</p></section></div></div>
<div class="footer">
<div class="revisionInfo">
- Last modified by <span class="author">Bertrand
Delacretaz</span> on <span class="comment">Fri Sep 29 15:57:01 2017 +0200</span>
+ Last modified by <span class="author">Radu Cotescu</span>
on <span class="comment">Mon Sep 24 15:23:37 2018 +0200</span>
</div> <p>
Apache Sling, Sling, Apache, the Apache feather logo, and
the Apache Sling project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their
respective owners.
</p><p>
diff --git a/documentation/development/release-management.html
b/documentation/development/release-management.html
index 47a9534..9033283 100644
--- a/documentation/development/release-management.html
+++ b/documentation/development/release-management.html
@@ -177,11 +177,20 @@ $ mvn release:prepare
<li>
<p>Verify the staged artifacts</p>
<ul>
- <li>If you click on your repository, a tree view will appear below. You
can then browse the contents to ensure the artifacts are as you expect them.
Pay particular attention to the existence of *.asc (signature) files. If you
don't like the content of the repository, right click your repository and
choose <em>Drop</em>. You can then rollback your release (see <em>Canceling the
Release</em>) and repeat the process</li>
+ <li>If you click on your repository, a tree view will appear below. You
can then browse the contents to ensure the artifacts are as you expect them.
Pay particular attention to the existence of *.asc (signature) files. If you
don't like the content of the repository, right click your repository and
choose <em>Drop</em>. You can then redo (see <a
href="#redoing-release-perform">Redoing release perform</a>) or rollback your
release (see <em>Canceling the Release</em>) and repeat the [...]
<li>Note the staging repository URL, especially the number at the end of
the URL. You will need this in your vote email</li>
</ul>
</li>
</ol>
+<h3><a href="#redoing-release-perform" name="redoing-release-perform">Redoing
release perform</a></h3>
+<p>If perform fails for whatever reason (e.g. staged artifacts are incomplete
or signed with a wrong key) drop the staging repository and create a required
<code>release.properties</code> file containing <code>scm.url</code> and
<code>scm.tag</code> manually.</p>
+<p>Example <code>release.properties</code> file:</p>
+<pre><code>scm.url=scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-settings.git
+scm.tag=org.apache.sling.settings-1.3.10
+</code></pre>
+<p>Execute perform step again:</p>
+<pre><code>$ mvn release:perform
+</code></pre>
<h3><a href="#redeploying-staged-artifacts"
name="redeploying-staged-artifacts">Redeploying staged artifacts</a></h3>
<p>It may happen that deployment to Nexus fails or is partially successful. To
fix such a deployment, you can re-deploy the artifacts from within the SCM
checkout:</p>
<pre><code>$ cd target/checkout
@@ -504,7 +513,7 @@ ssb 2048R/226BCE00 2016-01-21
</ol></section></div></div>
<div class="footer">
<div class="revisionInfo">
- Last modified by <span class="author">Robert
Munteanu</span> on <span class="comment">Wed Sep 12 13:59:44 2018 +0200</span>
+ Last modified by <span class="author">Oliver Lietz</span>
on <span class="comment">Sat Sep 22 12:37:02 2018 +0200</span>
</div> <p>
Apache Sling, Sling, Apache, the Apache feather logo, and
the Apache Sling project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their
respective owners.
</p><p>
