Render a GitHub ribbon on all sites#515
Render a GitHub ribbon on all sites#515slawekjaranowski wants to merge 1 commit intoapache:masterfrom
Conversation
reference: - apache#494 - apache#495
|
Maybe it's a personal thing, but when I see a "fork me" ribbon/sign, I always get the feeling that this means "Hey this project is inactive, consider to fork it and work on yourself". |
|
Why not but I think we had this in the past and remove it for some reasons |
|
For me a ribbon is the fastest way how external contributors may raise PRs! |
|
Maybe instead of ribbon we can add a right menu 
pinting to GitHub - will be more clear that |
in the past, we wanted to promote ASF Gitbox and we wanted to avoid promoting a commercial solution: now that ship sank quite some time ago at ASF... having a Ribbon on every released project site could help people, why not = what this PR ca do for the 2 "non-released projects" sites = maven-site and Doxia-site, there is always to question about getting the (non-versioned) site sources vs discovering the vast list of sub-projects. This is a separate discussion to have, even if these 2 sites will benefit by default form a link to the site's GH |
|
The next release introduces ribbons for plugins. That PR was back then approved by @olamy . Is there someone out there against this? |
I'm not against, even more if we introduce it for plugins - and we agree the it is ok, I think that the rest project also can have an easy link to GitHub project |
exactly - such #495 have been merged - we will have a GitHub ribbon for all plugins documentation .... I would like to our sites will look the same (similar) independent of component type, so I propose this PR |
|
before taking a decision, I tested #495 on a plugin: https://maven.apache.org/plugins-archives/maven-clean-plugin-LATEST/ given this is highly subjective, having a community discussion about activating it or not would (based on concrete example) make sense |
| 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. |
There was a problem hiding this comment.
- for multi-module projects, a fixed value has to be added to the build root (can I add a commit to the PR?)
- 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?
There was a problem hiding this comment.
- 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
- 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 ...
we can try to set projectId to empty value ... to avoid rendering .. but I'm not sure
There was a problem hiding this comment.
@hboutemy why do you want disable it on site like maven-site or doxia-site?
There was a problem hiding this comment.
good question
for Maven site or Doxia site, we already have an edit button that goes to the source of the page
and getting the same visual ribbon everywhere IMHO adds more confusion: of course, we need to see, I'm anticipating in my head
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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
5 participants
firsst pass done for plugins only:
this PR is about extending to all projects, not only plugins
require introduction of property
maven.site.gitHubProjectIdfor multi-module builds