elharo commented on code in PR #193:
URL: https://github.com/apache/maven-doap-plugin/pull/193#discussion_r4133505343
##########
src/site/markdown/examples/doap-in-use.md:
##########
@@ -26,14 +26,24 @@ under the License.
# Generated DOAP In Use
-DOAP is used to share informations (metadata) about a software project. Now
that you have a generated DOAP from POM by the DOAP Plugin, you need to publish
it.
+DOAP is used to share metadata about a software project. After generating a
DOAP file from the POM, publish it at a stable URL so that consumers can
retrieve it.
## How To Publish A DOAP File
-You need to publish it somewhere where the DOAP file will be accessible via an
HTTP or HTTPS request like a web server or SVN.
+Publish the file somewhere that is accessible over HTTP or HTTPS. A project
repository, a generated project site, or another web server are all suitable
locations. The important property is a stable URL that returns the generated
RDF document; no central DOAP directory is required.
By default, the DOAP Plugin generates the file in the reporting output
directory (i.e. ${project.reporting.outputDirectory}). So, it will be available
when you will deploy the Maven site via the
[`site:deploy`](http://maven.apache.org/plugins/maven-site-plugin/usage.html)
goal. See [Integrated DOAP Plugin With The Site
Plugin](./with-site-plugin.html) part for more information.
-# Examples for the Maven DOAP
+If the file is published with the project site, you can advertise it from the
site's HTML pages with a link such as:
-Our Maven DOAP file is share on SVN
[here](http://svn.apache.org/repos/asf/maven/maven-3/trunk/doap_Maven.rdf).
+```html
+<link rel="meta" title="DOAP" href="https://example.org/doap_example.rdf";
type="application/rdf+xml">
+```
+
+## How To Share A DOAP File
+
+Share the stable URL with the tools or catalogs that consume DOAP. Check their
current submission instructions before registering a project, since third-party
services and their availability can change independently of this plugin.
+
+# Example
Review Comment:
ping
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
