Skip to content

Render a GitHub ribbon on all sites #515

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.

Sign up for GitHub

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

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

Render a GitHub ribbon on all sites #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ under the License.
<maven.site.path>pom-archives/maven-LATEST</maven.site.path>
<rat.skip>true</rat.skip>

<maven.site.gitHubProjectId>maven-parent</maven.site.gitHubProjectId>

<!-- modules with documentation not need to install and deploy -->
<maven.install.skip>true</maven.install.skip>
<maven.deploy.skip>true</maven.deploy.skip>
Expand Down
9 changes: 9 additions & 0 deletions docs/src/site/apt/index.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,15 @@ mvn scm-publish:publish-scm

* History

** 46

A <<GitHub ribbon>> has been added to the generated site to provide a direct link to the project's GitHub repository.

A new configuration property <<<maven.site.gitHubProjectId>>> has been introduced.
By default, this property is set to <<<$\{project.artifactId\}>>>, is used to resolve the <<GitHub>> repository URL for the ribbon link.
Copy link
Member

@hboutemy hboutemy Nov 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

  1. for multi-module projects, a fixed value has to be added to the build root (can I add a commit to the PR?)
  2. what are instructions when ribbon has to be disabled, like on maven-site or doxia-site? or do we really want the ribbon also on main sites?

Copy link
Member Author

@slawekjaranowski slawekjaranowski Nov 17, 2025

Choose a reason for hiding this comment

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

  1. for multi-module projects, a fixed value has to be added to the build root (can I add a commit to the PR?)

of course - always

  1. what are instructions when ribbon has to be disabled, like on maven-site or doxia-site? or do we really want the ribbon also on main sites?

it is not easy, when we have defined ribbon in parent site.xml - always will be used ...

look at code https://github.com/apache/maven-fluido-skin/blob/de8a32f384bc01f1b527f20d00c920bf458482c5/src/main/resources/META-INF/maven/site-macros.vm#L466

we can try to set projectId to empty value ... to avoid rendering .. but I'm not sure

Copy link
Member Author

@slawekjaranowski slawekjaranowski Nov 17, 2025

Choose a reason for hiding this comment

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

@hboutemy why do you want disable it on site like maven-site or doxia-site?

Copy link
Member

@hboutemy hboutemy Nov 18, 2025

Choose a reason for hiding this comment

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

good question

for Maven site or Doxia site, we already have an edit button that goes to the source of the page
image

and getting the same visual ribbon everywhere IMHO adds more confusion: of course, we need to see, I'm anticipating in my head

Copy link
Member Author

@slawekjaranowski slawekjaranowski Nov 18, 2025

Choose a reason for hiding this comment

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

We have an edit button on the all editable sites .... but it is not visible for users
Ribbon is more easy way to access source repository

Copy link
Member

@hboutemy hboutemy Nov 18, 2025

Choose a reason for hiding this comment

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

on a site, if it is about editing Markdown or other markup, finding the source in GitHub has proven to be hard

any idea how to make that edit button more visible?

and for Maven site and Doxia site, "getting the same visual ribbon everywhere IMHO adds more confusion"

Copy link
Member

@hboutemy hboutemy Nov 18, 2025

Choose a reason for hiding this comment

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

let's have a few plugins with ribbon
then we'll add the ribbon to Maven site too
and we'll see what it feels like when someone goes from https://maven.apache.org/plugins/ to one plugin: same Ribbon visual, different target Git repository


** 38

As of version 38, this POM sets the Java source and target versions to 1.8. Thus, as any plugin (or other component)
moved to version 38+ of this POM, it moves to requiring Java 1.8 (was Java 1.5 since version 21, Java 1.6 since
version 27, and Java 1.7 since version 34).
10 changes: 0 additions & 10 deletions maven-plugins/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,6 @@ under the License.
<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">

<custom>
<fluidoSkin>
<gitHub>
<projectId>apache/${project.artifactId}</projectId>
<ribbonOrientation>right</ribbonOrientation>
<ribbonColor>gray</ribbonColor>
</gitHub>
</fluidoSkin>
</custom>

<body>
<breadcrumbs>
<item name="Plugins" href="https://maven.apache.org/plugins/index.html" />
Expand Down
2 changes: 2 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -971,6 +971,8 @@ under the License.
<!-- to be overridden -->
<maven.site.path>../..</maven.site.path>
<maven.site.path.suffix>LATEST</maven.site.path.suffix>
<!-- used by fluido Skin GitHUb ribbon -->
<maven.site.gitHubProjectId>${project.artifactId}</maven.site.gitHubProjectId>
<invoker.streamLogsOnFailures>true</invoker.streamLogsOnFailures>
<version.sisu-maven-plugin>0.9.0.M4</version.sisu-maven-plugin>
<version.plexus-utils>4.0.2</version.plexus-utils>
Expand Down
5 changes: 5 additions & 0 deletions src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ under the License.
</matomo>
<fluidoSkin>
<sourceLineNumbersEnabled>true</sourceLineNumbersEnabled>
<gitHub>
<projectId>apache/${maven.site.gitHubProjectId}</projectId>
<ribbonOrientation>right</ribbonOrientation>
<ribbonColor>gray</ribbonColor>
</gitHub>
</fluidoSkin>
</custom>

Expand Down
Loading