One important use case for Renku is to showcase work. Compared to just sharing a link to a GitHub repo, sharing a Renku link means that the viewer can access a running, interactive example. Great!
In order to showcase their work, users need to be able to show documentation describing what their project is about, like a README.
As an example, see Luke’s SPI project page which is a good candidate for being upgraded into a Renku project: ‣
It’s a low hanging fruit to support this user journey in Renku 2.0.
4 weeks
The goal of this pitch is to enable a user to add documentation to their project page. There are many future directions Renku documentation could go (displaying READMEs from code repos, supporting structured metadata documentation, documentation templates, etc), and this pitch is a first step with the basics: a free text field.
Rough sketch of project documentation showing below the component boxes on the project page.
The documentation displays on the project page, below the Sessions/Data/Code boxes. Users say that they want to see the documentation immediately, and not have to click somewhere else.
There needs to be a button somewhere on the project page to add documentation. I’m not sure where it should be exactly. Once the documentation is in place, the documentation should have an edit button, and an option to delete it.
The free text documentation field should support markdown, and the markdown is rendered nicely on the project page.
Nice to have: be able to preview the markdown before saving.