Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the Apache Maven Package configuration documentation #1669

Closed
Tracked by #35771
timothystone opened this issue Nov 28, 2020 · 1 comment · Fixed by #1670
Closed
Tracked by #35771

Update the Apache Maven Package configuration documentation #1669

timothystone opened this issue Nov 28, 2020 · 1 comment · Fixed by #1670
Labels
ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team

Comments

@timothystone
Copy link
Contributor

timothystone commented Nov 28, 2020

What article on docs.github.com is affected?

Configuring Apache Maven for use with GitHub Packages

What part(s) of the article would you like to see updated?

The instructions for configuring GitHub Packages for Apache Maven suggest user specific changes for package consumption that overrides inherited defaults and creates slight confusion.

In the resuable, data/reusables/package_registry/apache-maven-snapshot-versions-supported.md for SNAPSHOT support, the note that GitHub Packages support SNAPSHOT versions shows an example of configuring, and overriding, the inherited default of the Maven Central repository

...
<repositories>
  <repository>
	<id>central</id>
	<url>https://repo1.maven.org/maven2</url>
	<!-- default behavior, unnecessary 
	-->
	<releases><enabled>true</enabled></releases>
	<!-- overrides ``central''  behavior, but context suggests intended for the 
	``github'' repository 
	-->
	<snapshots><enabled>true</enabled></snapshots>
  </repository>
...

Instead, the reusable should be specific about the use of SNAPSHOT artifacts in the context of GitHub Packages. The resusable should provide additional context on how the artifact can be used by consuming projects.

The updated documentation is shown below.

{% data variables.product.prodname_registry %} supports SNAPSHOT versions of Apache Maven. To use the GitHub Package repository for downloading SNAPSHOT artifacts, enable SNAPSHOTS in the POM of the consuming project or your ~/.m2/settings.xml file.

<repositories>
  <repository>
	<id>central</id>
	<url>https://repo1.maven.org/maven2</url>
  </repository>
  <repository>
	<id>github</id>
	<name>GitHub OWNER Apache Maven Packages</name>
	<url>https://maven.pkg.github.com/OWNER/REPOSITORY</url>
	<releases>
	  <enabled>true</enabled>
	</releases>
	<snapshots>
	  <enabled>true</enabled>
	</snapshots>
  </repository>
  <!-- EACH package should be separately noted due to a limitation on group/organization
       level package resolution. This may lead to numerous `repository` definitions that
       are different in `REPOSITORY` only.
  -->
  <!-- <repository>
	<id>github</id>
	<name>GitHub OWNER Apache Maven Packages</name>
	<url>https://maven.pkg.github.com/OWNER/REPOSITORY</url>
	<releases>
	  <enabled>true</enabled>
	</releases>
	<snapshots>
	  <enabled>true</enabled>
	</snapshots>
  </repository>
  -->
  
</repositories>

Additional information

The reusable needs i18n/l10n that I cannot provide. I speak some German, but not enough to be correct in documentation.

@welcome
Copy link

welcome bot commented Nov 28, 2020

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 28, 2020
@janiceilene janiceilene removed the triage Do not begin working on this issue until triaged by the team label Dec 3, 2020
@janiceilene janiceilene linked a pull request Dec 4, 2020 that will close this issue
4 tasks
@chiedo chiedo added the ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team label Jan 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@timothystone @chiedo @janiceilene and others