adobe / adobe/aem-project-archetype

Add documentation for non-central settings.xml updates

Open
#1,260 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
596
Forks
431
Avg merge
10d 6h
Merged PRs (30d)
1

Description

Our enterprise environment means we use internal repos rather than the default central repo for Maven artefacts. Because of this, we had to amend the settings.xml file with a new repository with the ID "archetype" as per https://maven.apache.org/archetype/maven-archetype-plugin/archetype-repository.html in order to resolve the artefact and create a new project.

This isn't documented anywhere in this project but given Adobe's audience, this should be a reasonably common occurrence. Adding a small "if" case with a link to the page should be enough to remind users who do not have a 'central' ID repository in-use will have to take action.

Contributor guide

Open the contributing guide

Research direction

Start by checking the project's documentation around settings.xml and the Maven archetype repository guidance linked in the issue. Done means documenting the non-central repository case, including the required "archetype" repository ID and the linked reference.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.