Repository navigation
Replace the placeholder org profile README with a real overview - #59
Merged
Merged
Conversation
The profile README was still GitHub's starter template, including the commented-out prompts. It is the first page anyone sees at github.com/codehaus-plexus. Replaced with: what Plexus is now (libraries under Maven, not an IoC container), tables of the active artifacts with coordinates and Maven Central badges, and an explicit list of the archived repositories with what to use instead. Versions come from shields.io badges rather than being written out, so the page does not go stale after each release. Part of #58
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #58.
profile/README.md— the page rendered at the top of https://github.com/codehaus-plexus — is still GitHub's starter template. In full, currently:followed by GitHub's commented-out "here are some ideas to get you started" block, still in the file.
This replaces it with an actual overview.
What's in it
groupId:artifactId, a one-line description, and a link to Central.plexus-cipher→plexus-sec-dispatcher, which absorbed it;plexus-containers→ Sisu; and so on.Two deliberate choices
Versions are shields.io badges, not literals, so this page doesn't need editing after every release.
The one-line descriptions were written against the source rather than from the existing metadata — several repos have no description anywhere to copy from, and where one existed it was sometimes wrong. For example
plexus-javais described here as readingmodule-infoand splitting the classpath from the module path, which is whatjpms/LocationManageractually does.Please check
The retired-repo replacements are the part where I'd most like a second opinion, particularly
plexus-component-factoriesandplexus-maven-plugin, where I've written "nothing — obsolete under Sisu". If those still have a live use I don't know about, say so.