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

Replace Visio Diagrams #1240

Open
petersilva opened this issue Sep 27, 2024 · 1 comment
Open

Replace Visio Diagrams #1240

petersilva opened this issue Sep 27, 2024 · 1 comment
Labels
Developer not a problem, more of a note to self for devs about work to do. Discussion_Needed developers should discuss this issue. Documentation Primary deliverable of this item is documentation good first issue Good for newcomers help wanted Extra attention is needed Refactor change implementation of existing functionality. wishlist would be nice, not pressing for any particular client.

Comments

@petersilva
Copy link
Contributor

The only non-text format used in the documentation is a handful of Visio diagrams.
Some of those diagrams are exported to SVG format and then the svg is edited in a drawing program.
these are all in the docs tree:


SSC-5CD2310S60% find . -name '*.vsdx'  -o -name '*.vsd'
./fr/Explication/Concepts/sr3_exemple_de_flux.vsdx
./fr/Explication/Concepts/amqp_notion_de_flux.vsdx
./Explanation/Concepts/e-ddsr-components.vsd
./Explanation/Concepts/sr3_flow_example.vsdx
./Explanation/Concepts/amqp_flow_concept.vsdx
SSC-5CD2310S60%

Perhaps they could be replaced with open source tech.

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams

@petersilva petersilva added help wanted Extra attention is needed Developer not a problem, more of a note to self for devs about work to do. wishlist would be nice, not pressing for any particular client. Discussion_Needed developers should discuss this issue. labels Sep 27, 2024
@MagikEh MagikEh added good first issue Good for newcomers Documentation Primary deliverable of this item is documentation Refactor change implementation of existing functionality. labels Sep 27, 2024
@MagikEh
Copy link
Contributor

MagikEh commented Sep 27, 2024

I find the best 'pipeline' to making a diagram in mermaid is to doodle it out in paint/on paper to get it out of my head and then organize it in a way that's easily represented by mermaid. From there I like to use the https://mermaid.live/ editor to get realtime updates of the structure I'm typing in (don't have to hit preview to see little changes), and finally It's just a matter of pasting it into the docs.

flowchart LR
  
    FIND[Find a Visio diagram]
    DOODLE(Doodle it out)
    THINK{Can it be mermaidified easily?}
    MERM((Use mermaid.live to draft it))
    GIT[Dump graph into git]

    FIND --> DOODLE
    DOODLE ---> THINK
    THINK -->|Non| DOODLE
    THINK -->|Oui| MERM
    MERM --> GIT
Loading

I will note though, there are things in the mermaid.live editor that potentially aren't in github/gitlab, as the former use a markdown interpreter that's based off usually not the latest version of mermaid.

@petersilva petersilva changed the title replace visio diagrams Replace Visio Diagrams Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer not a problem, more of a note to self for devs about work to do. Discussion_Needed developers should discuss this issue. Documentation Primary deliverable of this item is documentation good first issue Good for newcomers help wanted Extra attention is needed Refactor change implementation of existing functionality. wishlist would be nice, not pressing for any particular client.
Projects
None yet
Development

No branches or pull requests

2 participants