Author: hboutemy
Date: Mon Jun 9 09:18:07 2025
New Revision: 1926274
URL: http://svn.apache.org/viewvc?rev=1926274&view=rev
Log:
clarify process vs form for DOAP file creation
Modified:
comdev/projects.apache.org/trunk/site/create.html
comdev/projects.apache.org/trunk/site/doap.html
Modified: comdev/projects.apache.org/trunk/site/create.html
URL:
http://svn.apache.org/viewvc/comdev/projects.apache.org/trunk/site/create.html?rev=1926274&r1=1926273&r2=1926274&view=diff
==============================================================================
--- comdev/projects.apache.org/trunk/site/create.html (original)
+++ comdev/projects.apache.org/trunk/site/create.html Mon Jun 9 09:18:07 2025
@@ -34,23 +34,26 @@
<h2>Create an ASF DOAP File</h2>
<div>
-<p>To be listed on this site, your Apache project must create a DOAP
-file. The DOAP format is RDF based, so while it is human readable,
+<p>To be listed on this site, your Apache project must create a <a
href="doap.html">DOAP
+file</a>. The DOAP format is RDF based, so while it is human readable,
it's primarily meant to be machine read. Creating the file from
scratch can be a little intimidating, so this page will allow you to
generate an initial file that can then be edited to suit.
Alternatively, you can browse the existing projects for one with
similar resources and use its DOAP file as a starting point.</p>
+<blockquote>
<div class="section">
+
<h3>
-<a id="complete"></a>Complete the form</h3>
+<a id="complete"></a>1. Complete <a href="#form">the form</a></h3>
-<p>Before completing this form, you should really read the <a
href="guidelines.html">guidelines</a>. The <a href="doapfaq.html">FAQ</a> page
may also prove useful.</p>
+<p>Before completing <a href="#form">this form</a>, you should really read the
<a href="guidelines.html">guidelines</a>. The <a href="doapfaq.html">FAQ</a>
page may also prove useful.</p>
<p>Please remember that the data contained in the DOAP file is used directly
on the website, so please take care when adding content.</p>
</div>
<div class="section">
+
<h3>
-<a id="customise"></a>Customise your file</h3>
+<a id="customise"></a>2. Customise your file</h3>
<p>The file that is created when you submit your data is only a starting
point. You'll likely need to modify some aspects of it, especially adding data
that the form doesn't allow you to enter. You should be able to simply
copy/paste/edit the sections you need to duplicate.</p>
<p>You may have more than one of the following sections:</p>
@@ -69,34 +72,35 @@ Similarly each "SVNRepository" must be i
</div>
<div class="section">
<h3>
-<a id="validate"></a>Validate your file</h3>
-
+<a id="validate"></a>3. Validate your file</h3>
+
<p>It is a good idea to check if your DOAP file is at least valid RDF.
-This can be accomplished using the <a
href="https://www.w3.org/RDF/Validator/";>W3C RDF Validator service</a>.
+This can be accomplished using the <a href="https://www.w3.org/RDF/Validator/";
target='_blank'>W3C RDF Validator service</a>.
While this won't tell you if your file meets DOAP or Apache
guidelines, it is at least a good basic sanity check. </p>
</div>
<div class="section">
<h3>
-<a id="submit"></a>Submitting your file</h3>
-
+<a id="submit"></a>4. Add your file to <a
href="https://github.com/apache/comdev-projects/blob/trunk/data/projects.xml";>ASF
projects feed</a></h3>
+
<p>
Your DOAP file should be stored somewhere that is publicly
accessible. For most projects this will be in their source code
repository, but there is no requirement for it to be stored
there.
-It is suggested that the DOAP file is stored somewhere in SCM such that it is
copied to the top level of the website.
+It is suggested that the DOAP file is stored somewhere in source control such
that it is copied to the top level of the website.
The DOAP does not belong in source or binary release bundles,
-and if it is under the normal source tree there will be multiple copies in
tags and branches, which may be confusing.
-Also if the DOAP is always referenced by the site URL it is very unlikely to
change, whereas SCM layouts are often changed.
+and if it is under the normal source tree, there will be multiple copies in
tags and branches, which may be confusing.
+Also if the DOAP is always referenced by the site URL, it is very unlikely to
change, whereas source control layouts are often changed.
</p>
<p>
-Once you have decided where the file will be stored,
-you can directly edit the file to get your project listed:<br>
-<code>https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/projects.xml</code><br>
-For example, add an entry like one of the following:
+Once you have decided where the DOAP file will be stored,
+you can directly edit the ASF projects feed file to get your project listed:
+<a
href="https://github.com/apache/comdev-projects/blob/trunk/data/projects.xml";><code>https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/projects.xml</code></a>
</p>
+<p>
+For example, add an entry like one of the following:
<pre>
<location>https://svn.apache.org/repos/asf/httpd/site/trunk/content/doap.rdf</location>
or
@@ -104,14 +108,18 @@ or
or
<location>https://raw.githubusercontent.com/apache/logging-chainsaw/master/doap_chainsaw.rdf</location>
</pre>
-
+</p>
+<p>
If using Git, make sure that the URL links to the raw DOAP content as per the
above examples.
<br>
Please keep the file in alphabetical order by TLP id (i.e. httpd, kafka,
logging in the above examples)
</div>
</div>
-<h2>DOAP Creation Form</h2>
+</blockquote>
+
+<h2>
+<a id="form"></a>DOAP Creation Form</h2>
<div>
<p>Before completing this form, you should really read the <a
href="guidelines.html">guidelines</a>.</p>
<p>When you submit this form, a sample file will be created and returned to
you. It will be named 'doap_<project>.rdf'. and will be presented as a
downloadable file.</p>
Modified: comdev/projects.apache.org/trunk/site/doap.html
URL:
http://svn.apache.org/viewvc/comdev/projects.apache.org/trunk/site/doap.html?rev=1926274&r1=1926273&r2=1926274&view=diff
==============================================================================
--- comdev/projects.apache.org/trunk/site/doap.html (original)
+++ comdev/projects.apache.org/trunk/site/doap.html Mon Jun 9 09:18:07 2025
@@ -51,7 +51,7 @@ and tell them to create a DOAP file and
<h4>More info on DOAP at ASF</h4>
<ul>
<li><a href="guidelines.html">Guidelines for creating an ASF DOAP file</a></li>
-<li><a href="create.html">Create an ASF DOAP</a> (Form-based wizard)</li>
+<li><b>TL;DR <a href="create.html">Create an ASF DOAP</a> (Form-based
wizard)</b></li>
<li><a href="doapfaq.html">DOAP FAQ</a></li>
</ul>
