Skip to content

Commit

Permalink
Move sequence diagrams to PlantUML SVG.
Browse files Browse the repository at this point in the history
The plantuml source used to generate the diagrams is embedded in the SVG
resources and can be modified and regenerated (by hand, at this time).

Remove annotation on Reader.
  • Loading branch information
RyanSkraba committed Oct 28, 2019
1 parent 501df3a commit 6418fb6
Show file tree
Hide file tree
Showing 6 changed files with 205 additions and 5 deletions.
6 changes: 3 additions & 3 deletions website/src/documentation/io/developing-io-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ Here is a sequence diagram that shows the lifecycle of the Source during
information to IO developers such as the constraints that
apply to the objects or particular cases such as streaming mode.


![This is a sequence diagram that shows the lifecycle of the Source](
{{ "/images/source-sequence-diagram.png" | prepend: site.baseurl }})
<!-- The source for the sequence diagram can be found in the the SVG resource. -->
![This is a sequence diagram that shows the lifecycle of the Source](
{{ "/images/source-sequence-diagram.svg" | prepend: site.baseurl }})

### Using ParDo and GroupByKey

Expand Down
4 changes: 2 additions & 2 deletions website/src/documentation/programming-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -809,9 +809,9 @@ Here is a sequence diagram that shows the lifecycle of the DoFn during
apply to the objects or particular cases such as failover or
instance reuse. They also give instanciation use cases.

<!-- The source for the sequence diagram can be found in the the SVG resource. -->
![This is a sequence diagram that shows the lifecycle of the DoFn](
{{ "/images/dofn-sequence-diagram.png" | prepend: site.baseurl }})
{{ "/images/dofn-sequence-diagram.svg" | prepend: site.baseurl }})

#### 4.2.2. GroupByKey {#groupbykey}

Expand Down
Binary file removed website/src/images/dofn-sequence-diagram.png
Binary file not shown.
94 changes: 94 additions & 0 deletions website/src/images/dofn-sequence-diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed website/src/images/source-sequence-diagram.png
Binary file not shown.
Loading

0 comments on commit 6418fb6

Please sign in to comment.