gitlab-training icon indicating copy to clipboard operation
gitlab-training copied to clipboard

Redraw all explanations for a more uniform look

Open dnsmichi opened this issue 6 years ago • 8 comments
trafficstars

This should be added again.

File lifecycle

dnsmichi avatar Dec 17 '18 08:12 dnsmichi

image

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

theFeu avatar Nov 06 '20 15:11 theFeu

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 avatar Jun 18 '21 14:06 theFeu

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

theFeu avatar Sep 21 '22 13:09 theFeu

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

martialblog avatar Sep 21 '22 14:09 martialblog

Looks scary, yet possible.

theFeu avatar Sep 21 '22 14:09 theFeu

@theFeu https://mermaid-js.github.io/mermaid/#/gitgraph

martialblog avatar Sep 21 '22 14:09 martialblog

Black magic!!

theFeu avatar Sep 21 '22 14:09 theFeu

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.

htriem avatar Oct 04 '22 14:10 htriem

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

martialblog avatar Dec 01 '22 19:12 martialblog