Make acknowledgements more prominently and enhance their content #361
Conversation
|
The page I generated with the current (non-final) state would have the following content. === Eclipse 2025-06 AcknowledgementsLast revised: June 9, 2025 We would also like to thank the users and adopters who support our efforts through a range of activities, including early testing, being a Friend of Eclipse, contracting special work, or outright employment. A special thanks goes to Holger Voormann for his Eclipse IDE promotion videos. Another special thanks to other Eclipse projects we build upon: EMF and ECF, who also provide timely updates so we can release on time. Eclipse PlatformThe Platform team would like to thank everyone who has helped us improve quality by testing and reporting bugs and enhancement requests.
Java Development ToolsThe JDT team thanks everyone who filed good enhancement requests, helped improve quality by testing and filing bug reports, and provided answers on JDT forums/newsgroups.
Plug-in Development EnvironmentThe Plug-in Development Environment team thanks numerous contributors who continue to improve the component every release.
EquinoxThe Equinox team thanks all contributors who helped improve the project by filing bug reports and enhancement requests.
Eclipse FoundationThe entire Eclipse Project team would like to thank the Eclipse Foundation staff for their tireless efforts and especially |
|
FYI it’s only discoverable via the more… page |
Something is wrong , some of contributor are not active in the list in PDE/Equinox but still showing R4_35..master |
Also "sorted alphabetically" seem not be correct, except it sorts by the github ID? |
|
Strange indeed This looks like the last commit that returns correct results up to
This goes back as far as
It's a bit inexplicable. |
|
Alois Zoitl |
|
For what it's worth, this does yield the correct result: $git log --after="2025-03-07" That is the date of this tag: https://github.com/eclipse-pde/eclipse.pde/releases/tag/R4_35 |
|
Of course the tag query is nicer because one can compute the tag so that nothing in the script needs to change... |
Please see the list of active TODOs from my initial message: This has not been done, but is planned to be done.
Since some spies were moved/merged from SWT to PDE in the past cycle, the git log might show more authors than actually have contributed. |
HannesWell
force-pushed
the
enhance-acknowledgements
branch
from
358896b to
3c058ad
Compare
|
I have now enhanced the Github workflow for the generation of the acknowledgements and addressed the following points
Content-wise respectively regarding the generated list of contributors, this is already the final state from my perspective and ready for full discussion. I have updated the example content in #361 (comment). I'm now looking into displaying the profile pictures next to the names like we do for the contributors in the N&N sections and will also try to further enhance the layout/arrangement of the names, as a simple vertical list needs a lot of vertical space and has a lot of white-space at the same time. I'm contemplating to use a ~three column table (but without header is difficult) or to go back to simply having all names concatenated in the text and relying on the implicit breaking of long lines. But I plan to do this after the profile-pictures are displayed so that one can assess style of the final result. Another point that is not yet resolved for me is the handling of co-authors mentioned in the commit message
In general Github recognizes them, but they seem not to be exposed by the Github-API when querying commits and I don't know a good way (yet) to find them. One solution could be, to just skip them. |
HannesWell
force-pushed
the
enhance-acknowledgements
branch
from
3c058ad to
6347c82
Compare
|
After making the pictures work, based on Ed's previous work for the N&N entries, I came up with the possible formatting options listed below. As a general remark: As this page is really about the people who contributed, I think it would be good to have their profile-pictures relatively large in the first place. At the same time it makes the text where only one or two people are mentioned, relatively hard to read and not looking well. Therefore I suggest to keep the picture smaller only for the latter case (i.e. for the few people that are always mentioned). But that being said, what's your favorite layout?
|
|
Thank you for working on this and making the proposals, @HannesWell! My favorite is 5 (followed by 3 and 1). It combines well-visible pictures with visual alignment (which I miss in option 3) while preserving some compactness (which I miss in option 1). |
|
Yes, I agree with Heiko. Option 5 looks well organized and you can visually scan for a name much more easily than any other option. |
|
I also quite like option 5 but I am not sure how mobile-friendly that option is. Regarding relying on automatic line breaks, it might be possible to prevent a line break between the profile picture and the corresponding username (e.g. by putting both in a |
Also add a Github workflow to generate them automatically with sophisticated content. Resolves - https://gitlab.eclipse.org/eclipse-wg/ide-wg/community/-/issues/77
HannesWell
force-pushed
the
enhance-acknowledgements
branch
from
6347c82 to
17660f5
Compare
Thanks for your opinions, I agree with it and updated the generation to create a corresponding table and also updated the java-script processing and CSS to render the table as suggested.
Good point, but I'm in general not sure how mobile friendly the N&N content is, but I can check it on my phone once it's merged. But since a lot is done from a few central places we can easily enhance this later. With that I consider this ready. I'll follow-up PRs to update the Thank you everyone for the discussion and your feedback. |
Take new acknowledgements file into account and simplify/unify the script in general. Follow-up on - eclipse-platform#361
Take new acknowledgements file into account and simplify/unify the script in general. Follow-up on - #361
7 participants
This enhances the existing acknowledgements to be more visible (I'm currently not aware of a common path through the website to it) and to enhance it's content, as currently it's only a plain text concatenating names.
With this change the acknowledgements are colocated to the news of each TLP and even linked from them. The list of contributors also becomes an actual list and each name is backed by a link to the authors GH account. I also intend to leverage #358 and inject the profile picture of each contributor.
Last but not least this adds a GH workflow to automate the creation and update of the contributor list in the new acknowledgements. It's currently triggered manually. Later we could also trigger this again automatically as part of preparation of the following next release (as it should be triggered in the end of a release-cycle).
Resolves
This is currently a draft that contains already has all the basics but requires improvements in the following points, of which some how to be discussed:
Currently the author name recorded in a git commit and the profile GH associates with it (probably by the author mail) is only used.
Impressions: