[ 
https://issues.apache.org/jira/browse/MNGSITE-492?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17602310#comment-17602310
 ] 

ASF GitHub Bot commented on MNGSITE-492:
----------------------------------------

gnodet commented on code in PR #287:
URL: https://github.com/apache/maven-site/pull/287#discussion_r967019021


##########
content/markdown/repositories/artifacts.md:
##########
@@ -0,0 +1,126 @@
+# Maven Artifacts
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+An Artifact is "anything" (any file) that can be addressed using their 
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,
+so they are not "just files", but they are files that are in some way 
addressable by Maven.
+
+Artifact coordinates, are most often represented as 
`groupId:artifactId:version`, or GAV in short or when 
+informally used (please note that Artifact coordinates has more fields, but 
for brevity we still call the 
+coordinates "GAV", not "GAVCE"). The artifact coordinate uniquely describe the 
artifact you are referring to, 
+but does not tell anything about its source (or origin). It is up to Maven to 
figure out (or you to tell Maven 
+how to figure it out).
+
+While Maven internally uses notion of "artifact" thoroughly (just look at 
sources!), end user may never hit this name.
+That's due the fact, that while for Maven, "everything is artifact" 
(internally), Maven end users actually speak about
+"projects", "parent projects", "dependencies", "build plugins", "build 
extensions" and so on.
+
+## Artifact properties
+
+The artifacts that Maven (internally) uses has following (for our topic 
related) properties:
+
+| Name         | Description                                       |
+|--------------|---------------------------------------------------|
+| groupId      | The artifact group                                |
+| artifactId   | The artifact name                                 |
+| version      | The artifact version (linked w/ baseVersion)      |
+| baseVersion  | The artifact base version (linked w/ version)     |
+| classifier   | The artifact distinguishing classifier (optional) |
+| extension    | The artifact extension                            |
+
+One property worth explaining is a bit of special one: `baseVersion` that is 
actually derived/linked-to 
+from `version` (or the other way around, depending on the context): for 
release artifacts, it holds the same value as 

Review Comment:
   That still does not sounds good :-(
   
   > that is actually derived from / linked to `version`, depending on the 
context.  For release artifacts...
   





> Create maven repository documentation
> -------------------------------------
>
>                 Key: MNGSITE-492
>                 URL: https://issues.apache.org/jira/browse/MNGSITE-492
>             Project: Maven Project Web Site
>          Issue Type: Improvement
>            Reporter: Tamás Cservenák
>            Priority: Major
>
> Maven Repositories, something that de facto became a standard, are not 
> covered on Maven site.... something we must make up for.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to