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

Redraw all explanations for a more uniform look #36

Closed
dnsmichi opened this issue Dec 17, 2018 · 9 comments · Fixed by #188
Closed

Redraw all explanations for a more uniform look #36

dnsmichi opened this issue Dec 17, 2018 · 9 comments · Fixed by #188
Assignees
Labels
feature New feature or request
Milestone

Comments

@dnsmichi
Copy link

This should be added again.

File lifecycle

@dnsmichi dnsmichi added the feature New feature or request label Dec 17, 2018
@dnsmichi dnsmichi added this to the 3.0.0 milestone Dec 17, 2018
@theFeu theFeu self-assigned this Oct 29, 2020
@theFeu
Copy link
Collaborator

theFeu commented Nov 6, 2020

image

Also a good picture. I might want to redraw it without the commands :)

@theFeu theFeu changed the title Image for file changes from modified, staged, committed Redraw all explanations for a more uniform look Jun 18, 2021
@theFeu
Copy link
Collaborator

theFeu commented Jun 18, 2021

git_redraw.zip

Redrew most of the images and saved them as SVGs
I will need some more time to finish them off, but looks decent so far :)

@theFeu
Copy link
Collaborator

theFeu commented Sep 21, 2022

This is a bit of a dated design looking at #141 - I would redo the other images from my previous comment in sketch.

@theFeu theFeu removed this from the 3.0.0 milestone Sep 21, 2022
@martialblog
Copy link
Member

showoff also ships with Mermaid https://github.com/puppetlabs/showoff/blob/main/documentation/AUTHORING.rdoc#label-Rendering+Diagrams

We could draw some stuff in Markdown

@theFeu
Copy link
Collaborator

theFeu commented Sep 21, 2022

Looks scary, yet possible.

@martialblog
Copy link
Member

@theFeu
Copy link
Collaborator

theFeu commented Sep 21, 2022

Black magic!!

@htriem
Copy link
Contributor

htriem commented Oct 4, 2022

Looks cool. Does anybody know what pygments would make of this? Anything useful, or would it be garbage? Might be a cool way to improve our .md file.

@martialblog martialblog added this to the 3.0.0 milestone Nov 29, 2022
@martialblog
Copy link
Member

I played around with mermaid.js some more. I think it could be a nice solution.

We can have all the Images/Graphs as text within the repo and then render them whenever something needs changing

$ docker pull minlag/mermaid-cli 
Using default tag: latest
latest: Pulling from minlag/mermaid-cli
Digest: sha256:768b5b0cfcb4c04b8b2a5db852e79cb339e0e752673af6face112577b819445e
Status: Image is up to date for minlag/mermaid-cli:latest
docker.io/minlag/mermaid-cli:latest

$ ls -l
graph.mmd

$ cat graph.mmd
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

$ docker run -u `id -u`:`id -g` --rm -v $(pwd):/data minlag/mermaid-cli -i /data/graph.mmd 
Generating single mermaid chart

$ ls -l
graph.mmd
graph.mmd.svg

I will have to look at all the images, but I think that could cover most usecases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants