apache / apache/maven-site

[MNGSITE-512] POM Reference: Repositories section confusing

Open
#870 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
123
Forks
301
Avg merge
16h 59m
Merged PRs (30d)
32

Description

**[Philippe Cloutier](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=chealer)** opened **[MNGSITE-512](https://issues.apache.org/jira/browse/MNGSITE-512?redirect=false)** and commented

[The Repositories section of the POM Reference page](https://maven.apache.org/pom.html#Repositories) is confusing. It covers one type of repositories (repositories of Maven artifacts), but not a much more common type of repositories (repositories of source code).

It would be less confusing to either:
* rename the section with a more specific title (such as "Artifact repositories")
* or also cover source code repositories, if that is supported

 

By the way, reviewing the section's current contents (e.g. discussing purpose before implementation) could also help.

---
No further details from [MNGSITE-512](https://issues.apache.org/jira/browse/MNGSITE-512?redirect=false)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the POM Reference page's Repositories section at maven.apache.org/pom.html#Repositories. Review whether the section should be renamed to distinguish artifact repositories or expanded to cover source code repositories, and clarify its purpose before implementation. Done means the section is no longer confusing and the chosen scope is reflected in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.