Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Security page in explanations has broken flowchart. #3734

Closed
MiroPalmu opened this issue Feb 3, 2025 · 1 comment · Fixed by #3795
Closed

docs: Security page in explanations has broken flowchart. #3734

MiroPalmu opened this issue Feb 3, 2025 · 1 comment · Fixed by #3795

Comments

@MiroPalmu
Copy link

Please describe the question or issue you're facing with "Security - Mir v2.19.3-120-g9fee39b0ea documentation".

The security page in explanations displays following instead of rendering it (tested on Mozilla Firefox 134.0.2 and Chromium 132.0.6834.110 Arch Linux):

 %%{ init: { 'flowchart': { 'curve': 'monotoneY' } } }%%
flowchart
    shell((Mir-based Shell))
    vnc_server(VNC Server)
    vnc_client(VNC Client)
    osk(On-screen Keyboard)
    snapd(Snapd)
    operator_app(Operator App)
    user(User)
    display(Display)
    app(App)

    subgraph snap [Snap]
        vnc_server--input-->shell
        shell--screen content-->vnc_server

        osk--content/input-->shell
        shell--input-->osk
    end
    
    shell--contents/configuration--->display
    snapd--configuration-->shell
    display--visuals-->user
    operator_app--help message-->shell
    user--input events-->shell
    display--properties-->shell
    vnc_server<--vnc-->vnc_client
    app--window contents-->shell
    shell--input/window management-->app

    classDef boundary fill:none,stroke-dasharray: 5 5
    snap:::boundary


Reported from: https://canonical-mir.readthedocs-hosted.com/latest/explanation/security/

@Saviq
Copy link
Collaborator

Saviq commented Feb 6, 2025

Thanks @MiroPalmu, not sure where this breaks yet... we'll need to dig through.

The same approach is used on e.g. https://canonical-mir.readthedocs-hosted.com/stable/explanation/architecture/ and it works there...

Saviq added a commit that referenced this issue Mar 4, 2025
github-merge-queue bot pushed a commit that referenced this issue Mar 5, 2025
Fixes: #3734

Unclear why/if it was needed before, but today it just breaks things.
Saviq pushed a commit that referenced this issue Mar 5, 2025
Fixes: #3734

Unclear why/if it was needed before, but today it just breaks things.
Azkali pushed a commit to Azkali/mir that referenced this issue Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants