Skip to content

Commit e8bf53b

Browse files
WVerlaekroboquat
authored andcommitted
[image-builder-mk3] Add sequence diagram
1 parent 901aff3 commit e8bf53b

File tree

4 files changed

+42
-1
lines changed

4 files changed

+42
-1
lines changed

components/image-builder-mk3/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
> Once completed, [#7845](https://github.com/gitpod-io/gitpod/issues/7845) will move `image-builder-mk3` (and image builds) from meta to workspace clusters.
66
7-
See the [Architecture page](https://www.notion.so/gitpod/Architecture-0e39e570b10f4e8ba7b259629ee3cb74) for more details, including a diagram.
7+
The following diagram shows what happens during a workspace image build. See the [Architecture page](https://www.notion.so/gitpod/Architecture-0e39e570b10f4e8ba7b259629ee3cb74) for more details.
8+
9+
![Architecture](../../docs/workspace/image-builder-mk3/sequencediagram.svg)
810

911
Relevant:
1012
* API definitions can be found [here](../image-builder-api/imgbuilder.proto)
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Image Builder Sequence Diagram
2+
3+
To edit the diagram:
4+
1. Go to https://sequencediagram.org/
5+
1. Open [`sequencediagram.txt`](./sequencediagram.txt)
6+
1. Make changes
7+
1. Export as SVG to [`sequencediagram.svg`](./sequencediagram.svg)
8+
1. Also save changed diagram source to [`sequencediagram.txt`](./sequencediagram.txt)
9+
1. Consider updating the copy of this diagram on the [Architecture page](https://www.notion.so/gitpod/Architecture-0e39e570b10f4e8ba7b259629ee3cb74#eb026f0404ae42b898a662a665fcef49) as well.

0 commit comments

Comments
 (0)