Project ideas for GSoC 2025

ebrehault · January 6, 2025, 1:15pm

Hello Plone people!!!

As the Stark family used to say in the famous Games of Plones TV show, "GSoC is coming" (I am not making this up, and fun fact: Aria Stark is the one who invented the HTML aria attributes, true story).

Anyway…

I need you to submit project ideas for this new GSoC season. To be honest, finding ideas is usually not too difficult for our community. What is more challenging is to find mentors, because people who are already active in the community get more and more tasks to do (contributing, being involved into different teams, or in the board, running sprints, etc.), and they end up being extremely busy, and mentoring a GSoC student is more they can reasonably handle.

My idea for this year would be to find Plone developers who are not very active in the community to become GSoC mentors. If a colleague of yours (or yourself) has some Plone knowledge, but is a bit shy, is a bit nervous about communicating in english, never goes to sprints or conference, well that's the person I am looking for .

Maybe you could encourage them to consider becoming a mentor!

Mentoring a GSoC student is not difficult, it does not require enormous social skills, and is an excellent first step to become active in the community (or not, if you really do not want to get involved, that's fine too actually).

Remember, GSoC projects can be anything you can imagine as far as it is not too long to implement. It can be smart features, like last year, we had:

RSS Support Add-on in Plone 6
Decoupled editor for Plone headless
AI/ChatGPT image description/alt text generator

But it can also be more low-level, as 2 years ago we had a purely technical topic: Refactor Class Components to Functional Components.

So please, let me know!

Thank you!!!!!!!

polyester · January 6, 2025, 1:49pm

One idea: an implementation of Keywordmanager for Volto. Basically, it is a tool to manage tags/keywords on a site. Over time, as multiple people tag content items, it is almost inevitable that there will be duplicates ("labor" vs "labour", various spellings of countries, etc).

Personally, I am sort of convinced that a way to handle (merge, change, delete) keywords should be more or less a core feature, but it's probably safer to have it as add-on first.

The UX for Products.Keywordmanager has always been a bit clunky, but functional. As it targets mainly site admins or 'senior editors', it doesn't have to be super userfriendly but should cope with hundreds or thousands of keywords.

There could be ways to help (like marking words that are spelled similarly) but ultimately it is an editor decision to say that e.g. "global warming" and "climate change" should be merged as tags, or not.

tkimnguyen · January 6, 2025, 4:15pm

This is totally off the top of my head, and it's not pure development, but a mix of dev and documentation: streamline/simplify the Plone installation instructions, which are spread out over docs.plone.org, training.plone.org, plone.org, crazy nut bar places like Plone in a Box™, and they have different target audiences to consider: back end devs, front end devs, add-on devs, I Just Wanna Have Fun And Use Plone people, with docker and without docker

tkimnguyen · January 6, 2025, 4:17pm

We have collective.exportimport (or is it importexport? I cannot remember now, thanks @pbauer) but can we have it be GUI based so mortals can use it?

tkimnguyen · January 6, 2025, 4:18pm

More current Volto themes!

tkimnguyen · January 6, 2025, 4:19pm

Workflow manager for Volto!

tkimnguyen · January 6, 2025, 4:20pm

It's probably just me not knowing how, but I have a site that is a clone of 2024.ploneconf.org, and it seems that to update the logo I have to change a file on the file system and rebuild the front end. Surely there's an easier way...?

tkimnguyen · January 6, 2025, 4:21pm

Easy sharing of content to all 999 social media networks.

Easy inclusion on a Plone site of all 999 possible social media streams/posts

tkimnguyen · January 6, 2025, 4:22pm

More Plone distributions

tkimnguyen · January 6, 2025, 6:34pm

4 posts were split to a new topic: GSoC 2025 idea discussion: social media sharing

djay · January 7, 2025, 7:28am

Here are the UI mockups from the last time this was attempted as a GSoC.

github.com/collective/plone.importexport

UX Roadmap (control panel, query widget, profiles, non-content settings etc)

opened 08:00AM - 12 Nov 18 UTC

djay

enhancement

If export had a search criteria widget then only that content would be exported…. Then you can include only content of a certain type or tags or author, not just by folder. It would make sense to move import/export into the site setup as part of this. Import/Export is more an admin function and doesn't make sense to both browse soemwhere and then use search criteria. This would keep the toolbar less cluttered. It might also make sense to do the same for imports as a way to specify what to replace or update or where to place new content. To place new content there would need be a clear rule that you need at least one path queury to say where it goes (or perhaps a more explicit option on where it goes?). The query lets you ensure only what you want to get updated gets updated, eg - only replace items published before a certertain date - only update News items - bulk delete any items created by X author - update the expiry date of Job adverts from this CSV and remove any not specified by custom id field Suggested UI ... ``` Profile [News Sync ] [Load] [Save] [ ] Allow contributors to use this profile in the Actions menu ____|Export|___|*Import*|____ Import File(s) - *warning* your import is large so will be done in multiple transactions from the browser. Please don't close your browser during upload. Aborting won't be possible. - a zip containing files in folder structures with a optional index.csv containing metadata (see format), or a single csv metadata file, or DND a folder here [ /tmp/myzip.zip ] [browse] Primary Key - Field in import metadata to match [UUID ] Existing content - to replace or update or add into {query widget} Path: /news Creation date: > 1/1/20018 If Content Matched (o) Update ( ) Replace ( ) Rename existing ( ) Rename new ( ) skip ( ) Abort If Content is New - relative paths will added to the first path found in the query widget - Content type field must be specified or use content type in query (o) Add and create folders ( ) Skip if folders don't exist ( ) Skip ( ) Abort If Existing doesn't Match ( ) Remove (o) Skip ( ) Abort If more than one Match ( ) Remove all except first ( ) Skip all but the first (o) Abort Settings imports [ ] Users (acl_users.csv) [ ] Themes (portal_resoures/*) [ ] Registry (portal_registry.csv) [ ] Generic Setup (portal_setup/*.xml) [Import] [Dry Run] [Cancel] Progress: 423/1024 (20s/43s) 383 Items have been updated 23 items didn't match and skipped (view...) 2 items were added (view...) 10 updates skipped due to permissions 5 adds skipped due to permissions [Download log] ``` and export would look like this ``` Profile [News Sync ] [Load] [Save] [ ] Allow contributors to use this profile in the Actions menu ____|*Export*|___|Import|____ Existing content - to export {query widget} Path: /news Path: /other-news Creation date: > 1/1/20018 Export Contents [x] Metadata (CSV format) [x] Files (Zip format) [ ] Users [ ] Settings [ ] Themes Metadata to export - *Warning*: not including Type,UUID can be result in broken plone imports ( ) All (o) Selected fields [relative path, effective_date, title ] [Export] [Dry Run] [Cancel] ``` This UI suggests many other features that need their own tickets - matching using primary key #9 - flexible options on matching #2 - dry run - progress and feedback summary and downloadable log #4 - named export/import profiles #10 - optional imports/exports from toolbar - Including other settings in the same zip - handling large imports via client side code #16 - handling folders instead of zips #11 Doesn't currently include UI - to map CSV fields to internal fields #7 - limit which fields you want to export

Certainly building on top of the excellent exportimport and using react would make this a lot more achievable now. I still think having it able to use csv in addition to json would be a great way to make it more useful to mortals. At least when the usecase is bulk updates or importing external data rather than exporting from one plone site back into another.

djay · January 7, 2025, 7:32am

An content warning system for when content violates custom rules, such as WCAG guidelines, design system rules or other organisation specific guidance. Similar to content rules but warning during edits as well as reports across the whole site.

djay · January 7, 2025, 7:38am

Repeater block.
The ability to reuse blocks types as the items in a listing to make listings more powerful. e.g. teaser listing, image listing etc.
In addition the ability to have sources plugins so listings can be other kinds of data not just plone search, for example social media posts, RSS feeds, related/recommended items to this content or links to search pages with different facets preselected.

github.com/plone/volto

PLIP: I can easily switch back and forth a listing/row of teaser styles (repeater block with selectable source and manually added items)

opened 02:44AM - 07 Mar 23 UTC

djay

03 type: feature (plip) 04 type: enhancement 99 tag: UX

# Problem - I have 12 teasers and I want to see how they look as Search resul…t items instead of cards # Proposed solution - For the Plone UX person to decide and test but this is what I'd like to test ## Repeater Block with auto-fill from query - replaces both listing block and teaser grids with something similar to [wix repeater block](https://support.wix.com/en/article/wix-editor-adding-and-managing-repeaters-lists-grids) - ie certain blocks types are marked to be repeatable. the repeater block lets you globally set - which block type to repeat - what layout for the repeating - the style of all the repeated blocks e.g. Repeater Block Settings ``` Repeat: [ Card Teaser v] Show: [ [Title x] [Image x] [Description x] [Date x] ] Image position: [ Left v] Card Colour: [ Light v] Layout: [ Grid v] Items per row: [ 3 ] Items per page: [ All ] Auto add Items from: [ From Query v] --- Query --- ... Map Fields [ Title=Title, Tag=Subject, Date=Publication Date ] ``` but you can switch this to a row of buttons ``` Repeat: [ Button v] Show: [ [Title x] ] Layout: [ Inline v] Items per page: [ All ] Auto add Items from: [ None v] ``` or turn it into a related items widget ``` Repeat: [ Tags v] Show: [ [Title x] ] Layout: [ Inline v] Items per page: [ All ] Auto add Items from: [ Related Items v] ``` or folder contents ``` Repeat: [ Summary v] Show: [ [Title x] [Image x] [Description x] [Date x] ] Image position: [ Left v] Layout: [ List v] Items per page: [ 10 ] Auto add Items from: [ Contents v] ``` or table ``` Repeat: [ Table Row v] Show: [ [Title x] [Image x] [Description x] [Date x] ] Layout: [ Table v] Header: [Y] User Sorting: [Y] Items per page: [ 10 ] Auto add Items from: [ Query v] ``` - A Repeatable Block (sub block) has the following - Some kind of registration marking it to be repeatable - All block content you enter WYSIWYG (ie not via settings) - the link might have to be set using a Quanta style toolbar like [ ⠿ 🔗 🗑 ] - the blocks settings are style related only and are now set for all the blocks in the repeater block (ie no customisation per sub block - e.g you hide image or description for all. (if show it again later, the data reappears) - A set of defaults to map query results to data on the block (optional) - Which layout styles it supports. or blacklist of combinations - e.g Volto Image block isn't current repeatable since it has caption, link and image source appearing in it's block settings - There is a line between the manual items and the auto items from query to show they are different. - any manual item with the same link is not shown in the auto items section. allows you to prioritise certain items. ``` [ Card 1 ] [ Card 2] --- preview auto added below --- [ Card 3 ] [ Card 4 ] Next 1 2 3 4 Last ``` - The repeatable block is similar to @tiberiuichim [UniversalCard](https://github.com/plone/volto/pull/3706#issuecomment-1339764918) idea - except here it only needs to be used in one block, the repeater block (not seperate listing block and teaser grid block) - Or it;s an rule/interface where any block can be used to repeat if we know which settings are global and which are edited inline (or can be filled by a query). Currently volto has no way to know the difference between style and data of a block. - Not all sub block types would support all layout styles - Cards might only be in grids, Buttons only inline, table rows can only be in a table etc. Calendar view might only work with cards? Map view with ?? - add button to add sub block (or DND from auto item preview) - if you DND the wrong block from outside it's rejected - there is still a standalone grid/row block when you want have different blocks side by side but this is a seperate thing - also Listing Block, Card Grids, button Block etc are still in the block palette but they would be preleaded repeater blocks - Pros - more intuitive. users think of the links first, then how best to present it - users don't often understand listing blocks. this makes it more discoverable. - supports queries with manual featured items - developers only have to create one sub block type that will work with both listings and grids - Cons: - might be confusing you can't reorder query teasers but can reorder the pinned manual teasers? @tiberiuichim implemented a version of this in c.cover which lets you combine manual items and query items [vokoscreenNG-2023-03-09_09-29-29.webm](https://user-images.githubusercontent.com/141568/223951364-a625c65a-e49e-4a75-bbb7-e1b2e5249082.webm) [wix style repeater block](https://support.wix.com/en/article/wix-editor-adding-and-managing-repeaters-lists-grids) (as suggested by @stevepiercy) is a little different in that it lets you design the exact layout of the card you are repeating. This idea is more about repeating fixed layouts but it might be possible later to create a sub block that lets rearrange its layout and have that repeated to all the other items. Another partial implementation is in [Plone 6 NSW Design System](https://digitalnsw.pretagov.com.au/components/grids). This doesn't yet combine queries into the same block but does show how easy it is change all the sub items at once. ![card grid](https://user-images.githubusercontent.com/41700/219249327-db4f7245-5988-4843-ab89-3eda76d0cace.gif) # Other Solutions considered ## Notion like convert to action - e.g. convert Listing Block to Button link Block. or Cards Grid to Vertical summary results list etc - Maybe in the settings of every block as top option ``` | Page | Block -------------- Listing Block Convert to [ Card Grid v ] ... ``` - Implementation: block authors define converter routines to/from standard blocks or common other plugins. At the min this is just a mapping of field names. - pros: - good idea for more things than just cards and listings. Can turn videos to images, or listings to static tables etc. - could still store old data so you can switch back and forth with no loss? - cons: - for solving the problem switching listing variations (manual or auto) seems a bit heavy handed. - you'd still need to be careful settings between different block types were similar so not confusing to the user. e.g if both had image visibile option it should be in the same place and be kept when converting - where to put it in the UI? in the settings make more sense but then it's an action so does picking switch it right away? ## Row Block and separate Teaser Block - What has currently been implemented. - pros: - Lets you set different variation for any particular teaser - cons: - lots of clicks to switch variations on all the teasers or change orientation You could enhance this by some kind of generic convert to action and multiple selection but its still more clicks and it's still not clear how you would hide or adjust settings across many blocks at the same time? ## Listing block with selectable sources cons: - you have to go somewhere else to manually sort or add items to the list. not WYSIWYG. # context following on from discussion in [Teaser Block in Core](https://github.com/plone/volto/pull/3706#pullrequestreview-1319620749) with @tiberiuichim ## Stories (in "assumed" order of how common) 1. I can enter teasers fully manually (ie manual title, description, image) 2. I can reorder teasers after adding 3. I can have a set of teasers side by side or vertically 4. I can have many variants of how rows or grids of teasers appear and switch between them easily 5. I add teasers where title is filled in automatically from the target content 6. I can have a set of teasers determined by single folder contents 8. I can have a set of teasers determined by a query 11. I can have a set of teasers that are inline buttons/tags rather than in a grid 15. I can customise a single title of a teaser in a query set of teasers 16. I can have a manual set of teasers but stored in a field like "related items" 17. I can quickly add a teaser by DND from a finder 13. I can a have a set of teasers determined by a query except a few which I pick to be first 9. I can switch a set to teasers from using a query to be a manual ordering 14. I can reuse a query or "source" between in many teaser sets so as not to type it again? 18. I can have a set of teasers that use different variations in the same set

Or alternatively, rather this being it's own block type, it could be a function of any container block type where you can switch the container to automatic/repeater mode by adding a source instead of manually adding. So sliders, accordians, grids, tables could all become listings

kartikaydev1 · January 8, 2025, 3:20am

Hello @polyester sir,
This is a great suggestion for an add-on! To handle duplication detection effectively, we can leverage a library like Levenshtein or FuzzyWuzzy to identify similar tags. The tool could then allow admins to merge, edit, or delete these duplicates directly through an intuitive interface. This approach ensures efficient management of keywords, even in large-scale scenarios.

I believe this implementation aligns well with the project idea. Looking forward to your thoughts!

Best regards,
[Kartikay Bhardwaj]

tkimnguyen · January 8, 2025, 5:18pm

We have https://pypi.org/project/collective.siteimprove/0.1b2/ GitHub - collective/collective.siteimprove: Siteimprove.com integration for Plone and I had worked briefly with a colleague at Wildcard Corp. to create something that would immediately provide WCAG related feedback, but on Plone Classic. It was a relatively small amount of JS that needed to be invoked.

djay · January 9, 2025, 4:30am

I was thinking of generalising these to be a rule based system and UI similar to content rules. Except it would be rules about blocks and content.
Such that implimenting certain WCAG feedback that relates to your custom blocks is easier.
Or custom design system rules like "this block should always have this special heading block before it"

tkimnguyen · January 10, 2025, 11:56pm

2 posts were split to a new topic: Bug in changing site logo (Volto)

tkimnguyen · January 12, 2025, 10:05pm

I'm not sure how much work it would be, but we should have this working with Plone: https://akismet.com

And Plone should be listed here (eventually): Plugins and libraries – Akismet

tkimnguyen · January 12, 2025, 10:08pm

Here's a pain point for me: I'm not smart enough to get pas.plugins.auth working... it's quite finicky. So: could we have a project that has it "preconfigured" to work with the most common authentication sources? e.g. GitHub, Google, Azure whatever-they're-calling-LDAP-this-month, etc.? Okta, and all the other centralized authentication services that are popular nowadays?

boss6825 · January 13, 2025, 6:05am

Would you be interested in helping specify the use cases for such a project? For example, would it be for basic testing, full production readiness, or a reference implementation?