ui5-webcomponents icon indicating copy to clipboard operation
ui5-webcomponents copied to clipboard

Published 20 hours ago • verified publisher icon SAP

Playground: rebuild the app to make it more lightweight

Open ilhan007 opened this issue 3 years ago • 3 comments

Feature Request Description

We would like to rebuild the playground app, so we can get rid of the ruby and Jekyll dependencies. Currently building the playground is very heavy, and often developers are experiencing various issues to run it locally, especially OS update.

Objective

Investigate lightweight solutions (NodeJS based) to show the UI5 Web Components documentation

Priority

  • [ ] Low
  • [x] Medium
  • [ ] High
  • [ ] Very High

ilhan007 avatar Nov 15 '21 07:11 ilhan007

I don't know, if this was brought up before:

when you rebuild the playground app, it would be very nice, if you could also improve the examples to show all necessary parts (javascript, tags, etc.) of a specific example. I noticed, that the examples are often incomplete. For example: at the moment i am trying to figure out how the busy-indicator works for the growing table component. It would be helpful, to see where busyIndicator is coming from, but there are many more incomplete examples in the playground.

aurora avatar Dec 17 '21 13:12 aurora

Re-implement the Playground and:

  • use the current structure, design and features (settings, search, etc..)
  • get rid of the ruby, Jekyll, Sass dependencies - it should be NodeJS based
  • make it easy to run/update locally
  • [on 2nd iteration] implement the Visual Design

Tools to research

  • 11ty
  • Storybook

ilhan007 avatar May 10 '22 08:05 ilhan007

  • [x] Integrate Storybook (add library, serve and build scripts, storybook/builder-vite)
  • [x] Make scripts to generate documentation.mdx files from .md (Getting Started, Theming, Accessibility, Table of contents, etc.)
  • [x] Valid DOM elements inside jsDocs (<br> -> </br>, etc.)
  • [ ] Make script and extract sample logic from old .sample.html and generate .stories.mdx
  • [x] Add to canvas theme change select, RTL and Compact/Cozy switch
  • [ ] Add theming for the whole storybook
  • [x] Check and propose better samples for Pirin components
  • [ ] Add to build process and integrate with current landing page

dobrinyonkov avatar Sep 20 '22 13:09 dobrinyonkov

Hi @dobrinyonkov I think we can close this issue, for now I will move it to 1.13.0 (1.12 has been released) and let you decide.

ilhan007 avatar Apr 04 '23 10:04 ilhan007

Closed with #5831

dobrinyonkov avatar Apr 06 '23 06:04 dobrinyonkov