Link in documentation to `parcels_contributions`

[nilodna]

Following the wrap-up discussion during the Parcels anniversary, I just wanted to throw in an idea for reflection: what about creating a page in the Documentation and Tutorials section that explains how to contribute new kernels to the parcels_contributions repository?

The page could include short guidelines on what to describe (e.g., what the kernel does, which manuscript to cite when using it, usage notes, etc.) and also list the existing kernels with brief summaries and links, so users can easily see what’s already available and get inspiration for their own contributions.

Perhaps it could go under the Worked Examples subsection on the left menu, or maybe as a new Contributions page?

I’d be happy to help write this page if the idea sounds useful, but I’d first love to hear your thoughts.

[VeckoTheGecko]

I’d be happy to help write this page if the idea sounds useful, but I’d first love to hear your thoughts.

I think its best to hold off for now. @reint-fischer is going to be working on the documentation, and we may consider a large overhaul. We also need to consider how projects like parcels_contributions relate to parcels and how they should be promoted.

Thanks for opening this line of discussion here! :)

[reint-fischer]

Thanks Danilo, I would love to make it easier for people to find and contribute their own Kernels, snippets, and workflows.

My first thought is that we should definitely include a link to the repository near the end of the list of tutorials. Perhaps we can start with expanding the README of the parcels_contributions repo? The examples in the repo have a very clear structure and description which we can work from.

[reint-fischer]

Pinging #2349, where I have implemented better linking to the repository and Parcels-code/parcels_contributions#14, where I opened a discussion on the name and hosting of the repository.

[VeckoTheGecko]

I think that linking to the parcels_contributions repo in the community section should be the extent to which we should consider it within the Parcels repository.

It is a separate project, so the original title of the PR

Instructions on how to contribute to parcels_contributions repository

as well as the maintenance of it moving forward should be considered within that parcels_contributions itself and is beyond scope for Parcels.

@CKehl you expressed interest during the anniversary event in the parcels_contributions repo - would you like to open a discussion in CLAM (i.e., a topic in the #general channel) to discuss what this looks like moving forward? (from a maintenance as well as accepting contributions POV?) It seems like there was community interest from the event, so hopefully it is something that can be maintained and be useful for people in the community. Personally I don't have the bandwidth to maintain parcels_contributions or update code in there for v4.