apache / apache/maven-scm-publish-plugin

Clarify documentation homepage with regards to the future of the plugin and relation to site deployment

Open Beginner friendly
#146 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
19
Forks
17
PR merge metrics
No merged PRs in 30d

Description

New feature, improvement proposal

Currently it is stated in https://github.com/apache/maven-scm-publish-plugin/blob/maven-scm-publish-plugin-3.3.0/src/site/apt/index.apt.vm inside Future Dreams that the plugin should become obsolete but rather part of m-site-p. However there is https://github.com/apache/maven-site-plugin/issues/1129 discussing whether publishing/deployment should rather be separated out from m-site-p.

Also it currently assumes this is only used for publishing site, hower this plugin can publish arbitrary filesystem structures. Although site deployment is probably the most prominent example it should be clarified, that this can be used for other stuff as well.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/site/apt/index.apt.vm, especially the Future Dreams section and the current description of the plugin's use. Read maven-site-plugin issue 1129 for the deployment discussion, then update the homepage to explain the plugin's future direction and that it can publish arbitrary filesystem structures, not only Maven sites. Done means the documentation is accurate and no longer implies site publishing is its only use.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.