Describe the parent POM as what it is - #437
Merged
Merged
Conversation
The description read 'The Plexus project provides a full software stack for creating and executing software projects.' That dates from when Plexus was an IoC container and application stack. It has not been true since Eclipse Sisu replaced the container, and our own overview page says so. It matters beyond this file: every project that does not set its own description inherits this one onto its generated site homepage. The plexus-i18n site currently renders it verbatim under the heading 'About Plexus I18N Component'. Descriptions are being added to the projects that lack one, so nothing should inherit this for long. plexus-interactivity, plexus-interpolation and plexus-io are the remaining three. Part of codehaus-plexus/.github#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
1 participant
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 codehaus-plexus/.github#58. One line.
The old sentence dates from when Plexus was an IoC container and application stack. It hasn't been true since Sisu replaced the container, and our own overview page says as much.
It leaks. Any project that doesn't set its own
<description>inherits this one onto its generated site homepage.https://codehaus-plexus.github.io/plexus-i18n/currently renders, in its entirety:So a visitor gets a sentence that tells them nothing about i18n and misdescribes the organisation, two clicks from the page that corrects it.
The real fix is per-project descriptions, and those are going in alongside the README work —
plexus-archiverandplexus-i18nalready have them in flight (codehaus-plexus/plexus-archiver#438, codehaus-plexus/plexus-i18n#37).plexus-interactivity,plexus-interpolationandplexus-ioare the three still missing one; I'll cover them as their READMEs come round.This change makes the fallback accurate in the meantime, and makes it obviously a parent POM description, which should prompt anyone who sees it inherited to add a real one.
Note this only becomes visible on the sites after the next release and site publish, so it isn't a fix anyone will see immediately.