This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doap-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 19afb4e docs: modernize DOAP publishing guidance (#193)
19afb4e is described below
commit 19afb4ed1289696b028208e3d1bbe9f6ea54cafa
Author: Efe <[email protected]>
AuthorDate: Mon Nov 9 21:44:08 2026 +0300
docs: modernize DOAP publishing guidance (#193)
---------
Signed-off-by: Efe Gökdemir <[email protected]>
---
src/site/markdown/examples/doap-in-use.md | 22 ++++++++++++++--------
src/site/markdown/index.md | 2 +-
2 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/src/site/markdown/examples/doap-in-use.md
b/src/site/markdown/examples/doap-in-use.md
index ee40cf4..d821b7b 100644
--- a/src/site/markdown/examples/doap-in-use.md
+++ b/src/site/markdown/examples/doap-in-use.md
@@ -26,19 +26,25 @@ under the License.
# Generated DOAP In Use
-Developers use DOAP to share information and metadata about a software project.
-The DOAP Plugin generates a DOAP file from a POM.
+DOAP is used to share metadata about a software project. After generating a
DOAP file from the POM, publish it at a stable URL. Consumers can then retrieve
the generated RDF document from that URL.
## How To Publish A DOAP File
-Publish the DOAP file on a web server or in source code control. Make sure
that other people can get the file with an HTTP or HTTPS request.
+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 (that is ${project.reporting.outputDirectory})
-so that it is included as part of the site.
+Projects that publish an HTML site can also advertise the RDF document with a
link element in the HTML header such as:
+
+```html
+<link rel="meta" type="application/rdf+xml" title="DOAP"
href="doap_example.rdf" />
+```
+
+By default, the DOAP Plugin generates the file in the reporting output
directory.
+That directory is `${project.reporting.outputDirectory}`, so the file is
included as part of the site.
For more information, read the [Integrated DOAP Plugin With The Site
Plugin](./with-site-plugin.html) page.
-# Examples for the Maven DOAP
+## 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.
-Our Maven DOAP file is shared on
-[SVN](http://svn.apache.org/repos/asf/maven/maven-3/trunk/doap_Maven.rdf).
+For example, a project publishing its Maven site at `https://example.org/` can
make its generated file available at `https://example.org/doap_example.rdf`.
Consumers can then fetch that URL directly, and the project can update the file
whenever its POM metadata changes.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index e2e7add..430f1ef 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -38,7 +38,7 @@ The DOAP Plugin has one goal:
- [doap:generate](./generate-mojo.html) Generates a DOAP file from the POM.
## Usage
-The [usage page](./usage.html) has general instructions for the DOAP Plugin.
The examples below describe specific ways to use the DOAP Plugin.
+The [usage page](./usage.html) has general instructions for the DOAP Plugin.
The examples below describe specific ways to use the DOAP Plugin.
- Examples
- Tips