•  
      request #37211 Replace TLP-doc documentation
    Infos
    #37211
    Joris MASSON (jmasson)
    2024-08-02 16:07
    2024-03-12 16:24
    38822
    Details
    Replace TLP-doc documentation

    Our custom documentation for our component library, named "TLP-doc", has served us well since its creation. However, it suffers from some issues:

    1. It requires a full Tuleap dev stack to run. It leverages the php / nginx engine of Tuleap to serve pages and load assets.
    2. It cannot be deployed in production. One of its features is to have a text editor that reflects its content directly to the web page. This can lead to self-XSS issues and is a security hazard.
    3. A consequence of 1. and 2., we cannot share that documentation to non-developers of Tuleap. It could be useful for our Product Design team (who cannot run a full Tuleap stack). It could also be useful to third party developers, who need to integrate some software with Tuleap.

    We should look for alternative tools to build the documentation for our component library.

    Other
    Empty
    Empty
    • [ ] enhancement
    • [ ] internal improvement
    Empty
    Stage
    Lou-Evan Rouby (lou-evan.rouby)
    Closed
    2024-08-02
    Attachments
    Empty
    References
    Referencing request #37211

    Git commit

    tuleap/tuleap/stable

    feat: storybook, a first simple story for badges b9d98c6ffa
    chore: Update contributors in README 4ea26cca98
    feat: Be able to change back to a theme color a2033e8704
    feat: storybook, structure and navigation components 9c631b9821
    feat: storybook, visual assets: avatars 9f3978c0b9
    feat: storybook, visual assets: typography 3c07ccfba0
    feat: storybook, visual assets: relative dates 42846589e8
    feat: storybook, visual assets: skeleton screens bb203a4d88
    fix: docs static site is repaired 17270e0c1c
    feat: storybook, buttons & switch f3d06de328
    Delete old tlp-doc version ca7c0c9ce8
    Sort files in tlp-doc-v2 d12978065e
    fix: Code in "show code" correctly indented in tlp-doc-v2 ef241e9028
    feat: storybook, buttons & switch ecd3c53936
    feat: add back TLP cards in pane cd69f8c51b
    fix: expose Storybook dev server only locally 6cd5323e9d
    feat: storybook, buttons & switch 516f5eb03e
    Delete old tlp-doc version 00e149f255
    feat: storybook, radios 2d3fa513a9
    feat: storybook, checkboxes 2aff930120
    feat: storybook, inputs 2d5fa6a66b
    feat: storybook, search dcb32fd7be
    feat: storybook, textareas 7a9e50e595
    feat: remove controls in TLP panes stories de2dbbf03f
    feat: storybook, properties 3d3843c4fe
    feat: storybook, select e59d76dd80
    feat: storybook, prepends 3cf5aa08bb
    fix: typos in example text 42ce452da6
    feat: storybook, listpicker 43ddfa42e9
    feat: storybook, appends 491082cbd3
    feat: storybook, forms: good practice a42163c313
    We should be able to add a label on prepends example c89bc460e5
    feat: storybook, list picker multiple 4f64381251
    feat: Match label with input 9661e06907
    chore: Ignore storybook static for linters 3cb256766b
    feat: storybook, colors b958058462
    feat: storybook, illustrations c518d3376e
    feat: storybook, icons ddcd1395bc
    feat: storybook, lazybox ddd13c652d
    feat: storybook, panes 9f163e6483
    feat: storybook, tables 1e7ab0dd46
    feat: storybook, lazyautocompleter 7b3ffd24db
    feat: storybook, tooltips f8aa630c2a
    feat: Have a Docker image to serve tlp-doc-v2 content 82752977f2
    feat: Add a Jenkinsfile to build and publish "tlp doc v2" container image 6f77d61348
    feat: Build only docs for design system website 3e249e592f
    feat: storybook, popovers e1d68d8f3c
    feat: storybook, date time picker 7730bd5d7a
    docs: Document why we need Wrapper custom elements in Storybook 1a4e677a81
    feat: Document the "loading" state of TLP switch 34a5f34027
    fix: Minor fixes on static doc 709e3c1751
    fix: Allow base64 data images 82a204087b
    feat: Use buttons for pagination 4cd8e90051
    feat: storybook, dropdowns 0d8d4d90e9
    feat: storybook, modals e34eee7941
    chore: Stop looking for stories everywhere ec37a5c160
    chore: links in storybook dc9c044917
    fix: Fix medium size modal and add wrappers for tabs and buttons adef1a9c07
    feat: introduction page and sort 0c8ee43a3d
    Delete old tlp-doc version c0e71a3cae
    chore: move angular and fetch documentations to readme files 9323fbf222
    chore: rename tlp-doc-v2 to tlp-doc 9fbf08092f
    Referenced by request #37211

    Artifact Tracker v5

    rel #37896 15.12

    Follow-ups

    User avatar
    Joris MASSON (jmasson)2024-08-02 16:07
    • Status changed from Under implementation to Closed
    • Assigned to changed from None to Lou-Evan Rouby (lou-evan.rouby)
    • Connected artifacts
    • Close date set to 2024-08-02
    User avatar
    Joris MASSON (jmasson)2024-03-12 16:51
    • Original Submission
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes