Copilot commented on code in PR #186:
URL: https://github.com/apache/maven-doap-plugin/pull/186#discussion_r4071587776
##########
src/site/markdown/examples/doap-in-use.md:
##########
@@ -26,23 +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 and diffuse it.
+People use DOAP to share information and metadata about a software project.
+The DOAP Plugin generates a DOAP file from a POM.
## 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 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.
-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.
+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.
-## How To Diffuse A DOAP File
+For more information, read the [Integrated DOAP Plugin With The Site
Plugin](./with-site-plugin.html) page.
-Several Semantic Web directories like
[http://doapspace.org/](http://doapspace.org/) or
[http://doapstore.org](http://doapstore.org) provide metadatas relating to open
source projects into a public catalog. You need to enter the DOAP file URL to
their catalogs.
+## How To Distribute A DOAP File
-You could also use the [Ping the Semantic Web](http://pingthesemanticweb.com/)
which share RDF data with the World.
+Enter the URL of the DOAP file into their catalogs. Use [Ping the Semantic
Web](https://pingthesemanticweb.com/) to share RDF data with the web.
Review Comment:
The instruction says to enter the URL into “their catalogs,” but no owner of
“their” is identified after the catalog-directory list was removed. This makes
the action ambiguous; refer directly to the catalogs.
##########
src/site/markdown/examples/doap-in-use.md:
##########
@@ -26,23 +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 and diffuse it.
+People use DOAP to share information and metadata about a software project.
+The DOAP Plugin generates a DOAP file from a POM.
## 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 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.
-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.
+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.
-## How To Diffuse A DOAP File
+For more information, read the [Integrated DOAP Plugin With The Site
Plugin](./with-site-plugin.html) page.
-Several Semantic Web directories like
[http://doapspace.org/](http://doapspace.org/) or
[http://doapstore.org](http://doapstore.org) provide metadatas relating to open
source projects into a public catalog. You need to enter the DOAP file URL to
their catalogs.
+## How To Distribute A DOAP File
-You could also use the [Ping the Semantic Web](http://pingthesemanticweb.com/)
which share RDF data with the World.
+Enter the URL of the DOAP file into their catalogs. Use [Ping the Semantic
Web](https://pingthesemanticweb.com/) to share RDF data with the web.
# Examples for the Maven DOAP
-Our Maven DOAP file is share on SVN
[here](http://svn.apache.org/repos/asf/maven/maven-3/trunk/doap_Maven.rdf).
Here are the result from some Semantic Web directories:
+The Maven project shares its DOAP file in this [SVN
repository](http://svn.apache.org/repos/asf/maven/maven-3/trunk/doap_Maven.rdf).
Some Semantic Web directories show this file:
Review Comment:
This newly edited repository link still uses HTTP, despite the PR's stated
requirement to convert documentation links to HTTPS. Use the HTTPS SVN URL.
##########
src/site/markdown/examples/with-site-plugin.md.vm:
##########
@@ -26,14 +26,14 @@ under the License.
# Integrated DOAP Plugin With The Site Plugin
-As described in [DOAP In Use](./doap-in-use.html), you need to publish the
generated DOAP file.
+You must publish the generated DOAP file, as described in [DOAP In
Use](./doap-in-use.html).
-By default, the generated DOAP file will be deploy using the
[`site:deploy`](http://maven.apache.org/plugins/maven-site-plugin/usage.html)
goal in the site specified in the _distributionManagement_ section of the POM.
+By default, the
[`site:deploy`](http://maven.apache.org/plugins/maven-site-plugin/usage.html)
goal deploys the generated DOAP file to the site that the
_distributionManagement_ section of the POM specifies.
Review Comment:
This newly edited link still uses HTTP, despite the PR's stated requirement
to convert documentation links to HTTPS. Use the HTTPS Maven Site Plugin URL.
##########
src/site/markdown/index.md:
##########
@@ -25,11 +25,11 @@ under the License.
-->
# Apache Maven DOAP Plugin
-The DOAP Plugin is used to generate a compliant [Description of a Project
(DOAP)](https://github.com/ewilderj/doap) file from a POM. The main goal is to
be able to provide DOAP files for Semantic Web systems that use them as primary
input but that would also alleviate the burden of maintaining two sets of
metadata.
+The DOAP Plugin generates a compliant [Description of a Project
(DOAP)](https://github.com/ewilderj/doap) file from a POM. The main goal is to
provide DOAP files for Semantic Web systems. These systems use DOAP files as
their primary input. This also removes the need to maintain two sets of
metadata.
-Version 1.0 of this plugin is specifically tailored for use by projects at
[Apache](http://projects.apache.org/doap.html), but this will change in
subsequent versions as more people become interested in DOAP.
+Version 1.0 of this plugin is designed for projects at
[Apache](http://projects.apache.org/doap.html). This will change in later
versions of the plugin, as more people become interested in DOAP.
Review Comment:
This newly edited Apache link still uses HTTP, despite the PR's stated
requirement to convert documentation links to HTTPS. Use the HTTPS project URL.
##########
src/site/markdown/faq.md:
##########
@@ -27,49 +27,36 @@ under the License.
1. [What is DOAP?](#What_is_DOAP)
2. [What are the benefits of DOAP?](#What_are_the_benefits_of_DOAP)
-3. [Why would I use DOAP when I have a
POM?](#Why_would_I_use_DOAP_when_I_have_a_POM)
+3. [Why do I use DOAP when I have a
POM?](#Why_would_I_use_DOAP_when_I_have_a_POM)
4. [What to do with the generated DOAP
file?](#What_to_do_with_the_generated_DOAP_file)
-5. [Why are not all developers/contributors listed in the DOAP file as
maintainer?](#Why_are_not_all_developers.2Fcontributors_listed_in_the_DOAP_file_as_maintainer)
+5. [Why aren't all developers and contributors listed as maintainers in the
DOAP
file?](#Why_are_all_developers.2Fcontributors_not_listed_in_the_DOAP_file_as_maintainer)
Review Comment:
This TOC link points to `#Why_are_all_developers...`, but the page defines
only the existing `Why_are_not_all_developers...` anchor below. Selecting item
5 therefore does not navigate to the answer; update the link to the defined
anchor (or rename the anchor).
--
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]
