Is there something like the @@test-rendering examples page from ClassicUI already existing in Volto?

Development Plone 6 UI (Volto)
1

The test_rendering view in classic Plone is not documented very well in the docs.

I am wondering if something similar exists for Volto?

I started a ticket to add this to the current docs https://github.com/plone/documentation/issues/1871

The view /@@test-rendering was available since at least Plone 3 (in Plone 2.5 we had /test_rendering).

The source is currently in https://github.com/plone/Products.CMFPlone/tree/master/Products/CMFPlone/browser/templates

  • Products/CMFPlone/browser/templates/test_rendering.pt
  • Products/CMFPlone/browser/templates/test_rendering_cheatsheet.pt
  • Products/CMFPlone/browser/templates/test_rendering_icons.pt
2

@acsr You can check the storybook: https://6.docs.plone.org/storybook

1 Like
3

Storybook was something I guessed but avoided to ask for explicitly in this same topic. Storybook is not easy to discover (and search for) or locate by navigation exactly until sneridagh pointed me there here. It misses an entry in the reference docs for VoltoUI.

  • The term Storybook is buried in Contributing to Volto/Documentation as subline.
  • it's root is listed in the Docs navigation at the same level as general Contributing to documentation but has no navigation item in the actual reference docs.
  • The Storybook build is not easy to discover there even if you are motivated.
  • The Style Guide topic mentions this unter Tooling around a design system but also only under contributing but not in reference docs. This is a blocker for newbies.

I would like to discuss some approaches here first before bloating the github with distracting tickets again.

Crosslinking

  1. @stevepiercy can we point to the Documentation (and Storybook) entry point in Volto from the general Contributing to documentation section? Or did I miss something obvious for others again?
  1. How can we integrate the terms Design System and Storybook into the reference Docs for VoltoUI Theming?
  1. How can we relate the Storybook stuff in Volto for people searching for old terms in Plone like test_rendering to have an entrypoint?

See also: ticket for ClassicUI.

  1. I would appreciate allowing people searching for the term Storybook in the context of ClassicUI allowing to find @@test_rendering.

I need to look up if there is something in the docs guidelines related to tagging content to relate beyond "see also:" without bloating the reading. Hints welcome.