From becf4b97e7ef8e8c73d7f1b4269823fda60ad2af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20B=C3=BCnger?= Date: Thu, 27 Feb 2025 20:10:15 +0100 Subject: [PATCH] [MPDF-113] Retire PDF plugin Updates pages to indicate the plugin has been retired. Broken links were also corrected or removed (see [MPDF-111]) --- README.md | 80 +------------ pom.xml | 2 +- src/site/apt/examples/filtering.apt | 3 + src/site/apt/index.apt.vm | 3 + src/site/apt/limitations.apt | 4 + src/site/apt/usage.apt.vm | 5 +- src/site/fml/faq.fml | 13 ++- src/site/site.xml | 1 - src/site/xdoc/download.xml.vm | 108 +++--------------- .../xdoc/examples/configuring-reports.xml.vm | 4 + 10 files changed, 44 insertions(+), 179 deletions(-) diff --git a/README.md b/README.md index 0606d68..d86035b 100644 --- a/README.md +++ b/README.md @@ -14,87 +14,17 @@ See the License for the specific language governing permissions and limitations under the License. --> -Contributing to [Apache Maven PDF Plugin](https://maven.apache.org/plugins/maven-pdf-plugin/) -====================== +RETIRED - [Apache Maven PDF Plugin](https://maven.apache.org/plugins/maven-pdf-plugin/) + [![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MPDF.json)][jira] [![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license] [![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-pdf-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.maven.plugins/maven-pdf-plugin) [![Reproducible Builds](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jvm-repo-rebuild/reproducible-central/master/content/org/apache/maven/plugins/maven-pdf-plugin/badge.json)](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-pdf-plugin/README.md) -[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-pdf-plugin/job/master.svg?)][build] -[![Jenkins tests](https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-pdf-plugin/job/master.svg?)][test-results] - - -You have found a bug or you have an idea for a cool new feature? Contributing -code is a great way to give something back to the open source community. Before -you dig right into the code, there are a few guidelines that we need -contributors to follow so that we can have a chance of keeping on top of -things. - -Getting Started ---------------- - -+ Make sure you have a [JIRA account](https://issues.apache.org/jira/). -+ Make sure you have a [GitHub account](https://github.com/signup/free). -+ If you're planning to implement a new feature, it makes sense to discuss your changes - on the [dev list][ml-list] first. - This way you can make sure you're not wasting your time on something that isn't - considered to be in Apache Maven's scope. -+ Submit a ticket for your issue, assuming one does not already exist. - + Clearly describe the issue, including steps to reproduce when it is a bug. - + Make sure you fill in the earliest version that you know has the issue. -+ Fork the repository on GitHub. - -Making and Submitting Changes --------------- -We accept Pull Requests via GitHub. The [developer mailing list][ml-list] is the -main channel of communication for contributors. -There are some guidelines which will make applying PRs easier for us: -+ Create a topic branch from where you want to base your work (this is usually the master branch). - Push your changes to a topic branch in your fork of the repository. -+ Make commits of logical units. -+ Respect the original code style: by using the same [codestyle][code-style], - patches should only highlight the actual difference, not being disturbed by any formatting issues: - + Only use spaces for indentation. - + Create minimal diffs - disable on save actions like reformat source code or organize imports. - If you feel the source code should be reformatted, create a separate PR for this change. - + Check for unnecessary whitespace with `git diff --check` before committing. -+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue. -``` -[MPDF-XXX] - Subject of the JIRA Ticket - Optional supplemental description. -``` -+ Make sure you have added the necessary tests (JUnit/IT) for your changes. -+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken. -+ Submit a pull request to the repository in the Apache organization. -+ Update your JIRA ticket and include a link to the pull request in the ticket. - -If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla]. - -Making Trivial Changes ----------------------- - -For changes of a trivial nature to comments and documentation, it is not always -necessary to create a new ticket in JIRA. In this case, it is appropriate to -start the first line of a commit with '(doc)' instead of a ticket number. - -Additional Resources --------------------- - -+ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch) -+ [Apache Maven PDF Plugin JIRA project page][jira] -+ [Contributor License Agreement][cla] -+ [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) -+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject) -+ #Maven IRC channel on freenode.org +This plugin is retired. It is no longer maintained. +=================================================== [jira]: https://issues.apache.org/jira/projects/MPDF/ [license]: https://www.apache.org/licenses/LICENSE-2.0 -[ml-list]: https://maven.apache.org/mailing-lists.html -[code-style]: https://maven.apache.org/developers/conventions/code.html -[cla]: https://www.apache.org/licenses/#clas -[maven-wiki]: https://cwiki.apache.org/confluence/display/MAVEN/Index -[test-results]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-pdf-plugin/job/master/lastCompletedBuild/testReport/ -[build]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-pdf-plugin/job/master/ + diff --git a/pom.xml b/pom.xml index 63f22b9..f76e512 100644 --- a/pom.xml +++ b/pom.xml @@ -31,7 +31,7 @@ under the License. 1.6.2-SNAPSHOT maven-plugin - Apache Maven PDF Plugin + (RETIRED) Apache Maven PDF Plugin Generates a PDF document from the project site. diff --git a/src/site/apt/examples/filtering.apt b/src/site/apt/examples/filtering.apt index dd0ebd5..35b06ec 100644 --- a/src/site/apt/examples/filtering.apt +++ b/src/site/apt/examples/filtering.apt @@ -28,6 +28,9 @@ Filtering Document Descriptor + <<>> This plugin is retired. It is no longer maintained. + + The document descriptor (aka src/site/pdf.xml) could be filtered by System properties, Maven project properties and some date properties. diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index ca9fc02..27766b2 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -28,6 +28,9 @@ ${project.name} + <<>> This plugin is retired. It is no longer maintained. + + This plug-in allows you to generate a PDF version of your project's documentation. diff --git a/src/site/apt/limitations.apt b/src/site/apt/limitations.apt index 8aed8da..adbc38e 100644 --- a/src/site/apt/limitations.apt +++ b/src/site/apt/limitations.apt @@ -28,6 +28,10 @@ Known Bugs and Limitations + <<>> This plugin is retired. It is no longer maintained. + + + Just a brief selection... * Missing Features diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm index 14aa492..3568cd3 100644 --- a/src/site/apt/usage.apt.vm +++ b/src/site/apt/usage.apt.vm @@ -28,6 +28,9 @@ Using The PDF Plugin + <<>> This plugin is retired. It is no longer maintained. + + The Maven PDF Plugin allows you generate a PDF document of your documentation. * From The Command-line @@ -149,7 +152,7 @@ Using The PDF Plugin located in <<>>. The format of this file has to be exactly the same as the original - {{{https://github.com/apache/maven-doxia/blob/master/doxia-modules/doxia-module-fo/src/main/resources/fo-styles.xslt}default configuration file}}. + {{{https://github.com/apache/maven-doxia/blob/doxia-1.x/doxia-modules/doxia-module-fo/src/main/resources/fo-styles.xslt}default configuration file}}. However, you only need to specify the properties that you want to override, to change the font size of pre-formatted text, you could use: diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml index f00828c..787e50f 100644 --- a/src/site/fml/faq.fml +++ b/src/site/fml/faq.fml @@ -1,4 +1,4 @@ - + diff --git a/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm index 3f71035..dbb5143 100644 --- a/src/site/xdoc/download.xml.vm +++ b/src/site/xdoc/download.xml.vm @@ -25,101 +25,19 @@ under the License.
- -

${project.name} ${project.version} is distributed in source format. Use a source archive if you intend to build - ${project.name} yourself. Otherwise, simply use the ready-made binary artifacts from central repository.

- -

You will be prompted for a mirror - if the file is not found on yours, please be patient, as it may take 24 - hours to reach all mirrors.

- -

In order to guard against corrupted downloads/installations, it is highly recommended to - verify the signature - of the release bundles against the public KEYS used by the Apache Maven - developers.

- -

${project.name} is distributed under the Apache License, version 2.0.

- -

We strongly encourage our users to configure a Maven repository mirror closer to their location, please read How to Use Mirrors for Repositories.

- - - - -

- [if-any logo] - - logo - - [end] - The currently selected mirror is - [preferred]. - If you encounter a problem with this mirror, - please select another mirror. - If all mirrors are failing, there are - backup - mirrors - (at the end of the mirrors list) that should be available. -

- -
- Other mirrors: - - -
- -

- You may also consult the - complete list of - mirrors. -

- - - - - -

This is the current stable version of ${project.name}.

- - - - - - - - - - - - - - - - - - -
LinkChecksumSignature
${project.name} ${project.version} (Source zip)maven/plugins/${project.artifactId}-${project.version}-source-release.zipmaven/plugins/${project.artifactId}-${project.version}-source-release.zip.sha512maven/plugins/${project.artifactId}-${project.version}-source-release.zip.asc
- - - - -

Older non-recommended releases can be found on our archive site.

- - +

${project.name} ${project.version} is distributed in source format.

+

Use a source archive if you intend to build ${project.name} yourself.

+

Otherwise, simply use the ready-made binary artifacts from central repository.

+

${project.name} is distributed under the Apache License, version 2.0.

+ + +

This plugin is retired. It is no longer maintained.

+

Historical releases can be found on our archive site.

+ +

It is essential that you verify the integrity of the downloaded file + using the checksum (.sha512 file) or using the signature (.asc file) against the public KEYS used by the Apache Maven developers. +

+
diff --git a/src/site/xdoc/examples/configuring-reports.xml.vm b/src/site/xdoc/examples/configuring-reports.xml.vm index ad922e7..80db070 100644 --- a/src/site/xdoc/examples/configuring-reports.xml.vm +++ b/src/site/xdoc/examples/configuring-reports.xml.vm @@ -30,6 +30,10 @@ under the License.
+

+ Note This plugin is retired. It is no longer maintained. +

+

Since version 1.1, all Maven reports will be included by default in the generated PDF. You should configure the <reporting/> section of your POM similar than the