镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

Replace the placeholder org profile README with a real overview - #59

Merged
slachiewicz merged 1 commit into
masterfrom
docs/org-profile-readme
Aug 8, 2026
Merged

slachiewicz merged 1 commit into
masterfrom
docs/org-profile-readme

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

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:

Hi there 👋

It's All the Plexus code here from the old good Codehaus

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

  • One paragraph on what Plexus is today: small libraries that Maven and its plugins are built on. Most people reach us through a transitive dependency, so the page leads with that rather than with history.
  • A short note that the IoC container is retired and Sisu replaced it. Worth stating plainly on the front page, because the name still makes people expect a container — and because our own site currently says both things in different places.
  • Three tables (libraries / components / tooling) with the real groupId:artifactId, a one-line description, and a link to Central.
  • An explicit Retired table for the 8 archived repos, each with what to use instead. plexus-cipher → plexus-sec-dispatcher, which absorbed it; plexus-containers → Sisu; and so on.
  • Links to CONTRIBUTING and SECURITY, which are added in a companion PR.

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-java is described here as reading module-info and splitting the classpath from the module path, which is what jpms/LocationManager actually does.

Please check

The retired-repo replacements are the part where I'd most like a second opinion, particularly plexus-component-factories and plexus-maven-plugin, where I've written "nothing — obsolete under Sisu". If those still have a live use I don't know about, say so.

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
@slachiewicz slachiewicz added the documentation Improvements or additions to documentation label Aug 8, 2026
@slachiewicz
slachiewicz merged commit 8d21793 into master Aug 8, 2026
@slachiewicz
slachiewicz deleted the docs/org-profile-readme branch August 8, 2026 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant