ui-components icon indicating copy to clipboard operation
ui-components copied to clipboard

Create new versions of documentation website

Open ArakTaiRoth opened this issue 1 year ago • 1 comments

Info

We need to be able to support the latest version up to our major upgrade, and the versions after our upcoming major upgrade (after the following story #1379), on our documentation. As we will have to support the two versions simultaneously for a period of 3 months.

This will be done by implementing a system similar to Bootstrap's documentation, where they have the version # in the URL, and that separates which version the documentation is for.

Acceptance Criteria:

  1. We have two different URLs for component documentation
  2. We will have to write all new documentation for Angular and React for the new version being supported.

Tasks below:

  • [x] Handle different versions and routes for v3 angular, v4 react and current version for both react and angular
  • [x] Tweak Sandbox code auto-generated code snippet for v3 angular, v4 react and current version for component name
  • [x] Figure out how to display component properties tables from different version (accordion)
  • [ ] Add microsite header version slot and have a basic method/dropdown to allow user navigates between v3 angular, v4 react, current versions. Make sure the component side menu link will handle well (perhaps we replace the URL of side menu item to handle v3, v4..)
  • [ ] Remove language dropdown from side menu
  • [ ] Handle sandbox code generated code snippet for different version, camel case for latest angular version, smaller case for v3 angular version. Handle form control (reactive form).
  • [ ] Handle form module [ngModel] for angular input components using code sandbox generator
  • Recheck all the code snippets handled with below components:
  • [ ] Accordion
  • [ ] Callout
  • [ ] Container
  • [ ] Details
  • [ ] Hero Banner
  • [ ] List
  • [ ] Popover
  • [ ] Table
  • [ ] Badge
  • [ ] Chip
  • [ ] Modal
  • [ ] Notification Banner
  • [ ] Progress Indicator
  • [ ] Skeleton Loading
  • [ ] Tooltip
  • [ ] Button
  • [ ] Button Group
  • [ ] Checkbox
  • [ ] Datepicker
  • [ ] Dropdown
  • [ ] File uploader
  • [ ] Icon button
  • [ ] Radio
  • [ ] Text area
  • [ ] Input
  • [ ] Footer
  • [ ] Form Stepper
  • [ ] Header
  • [ ] Microsite Header
  • [ ] Pagination
  • [ ] Side Menu
  • [ ] Tabs
  • [ ] Block
  • [ ] Divider
  • [ ] Form Item
  • [ ] Grid
  • [ ] Icons
  • [ ] Spacer
  • [ ] Patterns example code snippet

ArakTaiRoth avatar May 08 '24 00:05 ArakTaiRoth

Can't be done until #2035 and #2053 are complete

ArakTaiRoth avatar Aug 23 '24 17:08 ArakTaiRoth