Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Download page template #218

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Download page template #218

wants to merge 1 commit into from

Conversation

slawekjaranowski
Copy link
Member

No description provided.

@slawekjaranowski slawekjaranowski requested a review from kwin December 6, 2024 20:40
@slawekjaranowski
Copy link
Member Author

@kwin try to prepare template for download page ....

Questions:

  • should template be in parent pom project ... maybe in maven-apache-resources but it is for ASF, so maybe new project for Maven project templates ...

@slawekjaranowski
Copy link
Member Author

and using in plugin apache/maven-changes-plugin#93

<version>44-SNAPSHOT</version>
</parent>

<artifactId>maven-shared-doc-resource</artifactId>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather name this maven-shared-site-resource as the files in it are pretty maven-site specific. doc seems to generic for these files.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still is a question - should such template be placed in this project or some other?

under the License.
*#
#set( $h = "#" )
#set( $downloadDirectory = $project.properties.downloadDirectory )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need some documentation of the properties used by this template.

Copy link
Member Author

@slawekjaranowski slawekjaranowski Dec 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when we make decision where we should put it we will add a documentation

<goals>
<goal>process</goal>
</goals>
<phase>none</phase>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather bind this to pre-site

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

due to inheritance we can put here pre-site

docs/pom.xml Show resolved Hide resolved
<executions>
<execution>
<id>site-download</id>
<phase>pre-site</phase>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of putting this config into each pom leveraging the templates, I would rather set https://maven.apache.org/plugins/maven-remote-resources-plugin/process-mojo.html#skip based on the values of downloadDirectory/downloadArtifact in the main parent pom.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the most of we have a download page in project root pom, properties will also available in childs ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, one possible way is to set the properties only for the current pom, but not if used as parent (https://github.com/apache/maven-apache-parent/blob/061e19af986a914df4d37b14e7e53a079d9033c5/pom.xml#L486)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it will be more complicated ... we will need a mark file in all project

@kwin
Copy link
Member

kwin commented Dec 8, 2024

Maybe the approach in https://felix.apache.org/documentation/downloads.html (https://github.com/apache/felix-antora-site/edit/main/modules/ROOT/pages/downloads.adoc) works better. There the link is only resolved once the user clicks on download. No need for executing lua scripts (with potential performance penalty) for just rendering the download page itself. WDYT @slawekjaranowski ?

@slawekjaranowski
Copy link
Member Author

Maybe the approach in https://felix.apache.org/documentation/downloads.html (https://github.com/apache/felix-antora-site/edit/main/modules/ROOT/pages/downloads.adoc) works better. There the link is only resolved once the user clicks on download. No need for executing lua scripts (with potential performance penalty) for just rendering the download page itself. WDYT @slawekjaranowski ?

Looks ok, we will not a special steps to render page - simply we be static.

@slawekjaranowski slawekjaranowski force-pushed the dowload-templat branch 3 times, most recently from 8d73dd8 to 6c6528d Compare December 8, 2024 12:10
@slawekjaranowski
Copy link
Member Author

@kwin I hop now template looks better

I will move it to https://github.com/apache/maven-apache-resources where we have other resources bundles

@@ -914,6 +914,7 @@ under the License.
<module>maven-skins</module>
<module>doxia-tools</module>
<module>docs</module>
<module>maven-shared-doc-resource</module>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will try to work on MSITE-911 in the near future, so this doesn't need to be maintained outside the parent project.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My approach to put it in external repo are:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @slawekjaranowski

The Commons Build and Release plugins are not deprecated and generates a lot more than just one page. I use them for all Commons releases.

What I'm more interested in getting rid of is the commons-skin plug-in but I don't know if it's possible to fold it in commons-parent directly.

It would be nice to merge the Build and Release plugin but I never took the time to do it.

Ideally, I'd prefer to have all three current plug-ins in commons-parent, so I have 1 framework-y thing to deal with instead of 4.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that Build and Release plugins are not deprecated but use deprecated ant mojo

@slachiewicz
Copy link
Member

Maybe instead of download page for each component in each project we could simply link to one "big" page on Maven site - with links to all latest source code downloads?

@slawekjaranowski
Copy link
Member Author

Maybe instead of download page for each component in each project we could simply link to one "big" page on Maven site - with links to all latest source code downloads?

template in one place look also ok for me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants