hboutemy commented on code in PR #1224:
URL: https://github.com/apache/maven/pull/1224#discussion_r1317109620
##########
maven-repository-metadata/src/site/apt/index.apt:
##########
@@ -27,38 +27,8 @@ Maven Repository Metadata Model
This is strictly the model for Maven Repository Metadata, so really just
plain objects.
- The metadata file name is:
-
- * <<<maven-metadata.xml>>> in a remote repository,
-
- * <<<maven-metadata-\<repo-id>.xml>>> in a local repository, for metadata
from a repository with <<<repo-id>>> identifier.
-
- []
-
- Depending on what the directory represents ("groupId", "groupId/artifactId"
or "groupId/artifactId/version"),
- the Maven Repository Metadata file contains 3 different sets of metadata:
-
- [[1]] in a "groupId" directory: a "groupId" directory may contain Maven
plugins artifacts, which are described in metadata's <<<plugins>>> element,
-
- [[2]] in a "groupId/artifactId" directory: metadata describes <<<groupId>>>,
<<<artifactId>>> and <<<versioning>>> element that
- gives data about available versions (<<<latest>>>, <<<release>>>,
<<<versions>>> list and <<<lastUpdated>>>),
-
- [[3]] in a "groupId/artifactId/version" snapshot artifact directory: metadata
describes <<<groupId>>>, <<<artifactId>>>, <<<version>>> (base version, i.e.
ending in <<<-SNAPSHOT>>>) and
- <<<versioning>>> element that gives data about snaphot (<<<snapshot>>>,
<<<lastUpdated>>> and <<<snapshotVersions>>> list). Notice that a
- release artifact directory is not expected to provide metadata.
-
- []
-
Review Comment:
I really prefer keeping this explanation here (for example the local
repository filename is specific)
but yes, adding a link to
https://maven.apache.org/repositories/metadata.html is useful
we always have feelings about what goes to release documentation from code
vs what goes to main Maven site: both have an interest, it's useful to cross
link more than having one swallow the other
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
