•  
      request #37211 Replace TLP-doc documentation
    Infos
    #37211
    Joris MASSON (jmasson)
    2024-08-02 16:07
    2024-03-12 16:24
    38853
    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
    Referenced by request #37211

    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