[MNGSITE-521] Copy edit and clarify artifacts.md #629
Conversation
I think we still need to more precisely define "dependency type" but this is a good start.
elharo
changed the title
| An Artifact is "anything" (any file) that can be addressed using its coordinates, and Maven downloads, installs or | ||
| deploys for you. Most of them are POMs and JARs but | ||
| an artifact can be really anything. A very important thing about artifacts is that they have coordinates, | ||
| An artifact is a file (more precisely, a sequence of bytes) that can be addressed using its coordinates |
There was a problem hiding this comment.
Perhaps something like
"A file is a sequence of bytes addressed by a path in a file system. A resource is a sequence of bytes addressed by a URL. An artifact is a sequence of bytes addressed by Maven coordinates."
| (Please note that artifact coordinates have more fields, but for brevity we still call the | ||
| coordinates "GAV", not "GAVCE"). The artifact coordinates uniquely identify an artifact, | ||
| but do not specify anything about its source. It is up to Maven to figure out (or you to tell Maven | ||
| how to figure out) how and from where to retrieve the artifact. |
There was a problem hiding this comment.
Do we tell Maven or do we break with CoC and configure Maven? Maybe we can avoid the double "figure out" and "how" here, by "It is up to Maven to figure out (or you tell Maven) how and from ..." ?
There was a problem hiding this comment.
CoC doesn't specify which repository to load artifacts from, especially when local mirrors are in play. That's usually off in settings somewhere.
|
|
||
| | Name | Description | | ||
| |-------------|-------------------------------------------------| | ||
| | groupId | The artifact group | |
There was a problem hiding this comment.
In https://maven.apache.org/guides/mini/guide-naming-conventions.html we named it "project group", maybe align?
| | Name | Description | | ||
| |-------------|-------------------------------------------------| | ||
| | groupId | The artifact group | | ||
| | artifactId | The artifact ID | |
There was a problem hiding this comment.
and here "The artifact name"?
There was a problem hiding this comment.
I'm not sure that's accurate. I'd prefer to introduce new concept like name here
|
|
||
| Maven Core out of the box [defines following "types" (handled by same named `ArtifactHandler` components)](/ref/current/maven-core/artifact-handlers.html): | ||
| Out of the box, Maven Core defines the [following "types" (handled by the same named `ArtifactHandler` components)](/ref/current/maven-core/artifact-handlers.html): | ||
|
|
||
| | Type Name | Extension | Classifier | | ||
| |--------------|-----------|--------------| |
There was a problem hiding this comment.
I think with Maven 4, bom is missing.
There was a problem hiding this comment.
Maven 4 hasn't shipped yet
I think we still need to more precisely define "dependency type" but this is a good start.