Skip to content

Commit

Permalink
simplify wording about editing diagrams
Browse files Browse the repository at this point in the history
incorporate feedback from tech writers
  • Loading branch information
pauldougan committed Apr 2, 2024
1 parent 2dcad20 commit b2d21e4
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,26 @@ In order to configure some aspects of layout, like the header, edit `config/tech
If you move pages around and URLs change, make sure you set up redirects from the old URLs to the new URLs.

## Making changes to a diagram
To make changes to a diagram, you'll need to edit the `drawio` files in `source/images/originals` using the draw.io desktop app.
Edit the `drawio` files in `source/images/originals` using the draw.io desktop app.

Use one drawio file per diagram.

### Install draw.io desktop app
1. Install the draw.io desktop app using Homebrew with the following command:
1. Use the following commands so that you can use draw.io at the command line (this will alias the binary):
```
brew cask install drawio
```
2. Alias the binary so that you can just type `draw.io` at the command line. Use the following command to do this:

```
alias=draw.io='/Applications/draw.io.app/Contents/MacOS/draw.io'
```
### Edit and publish the diagram
Follow these steps:
1. Create and modify the diagram using [draw.io](https://about.draw.io/).
1. Store the draw.io original file in `source/images/originals`.
1. Publish the diagram as a [scalable vector graphic (SVG)](https://www.w3.org/Graphics/SVG/).
1. Store the SVG in the `source/images` folder.
2. Store the draw.io original file in `source/images/originals`.
3. Publish the diagram as a [scalable vector graphic (SVG)](https://www.w3.org/Graphics/SVG/).
4. Store the SVG in the `source/images` folder.

### Useful commands
Update a diagram:
```
Expand All @@ -72,6 +73,7 @@ draw.io source/images/originals/top-level-technical-diagram.drawio
Generate SVG versions of the diagrams:
```
draw.io -x -o source/images/top-level-technical-diagram.svg source/images/originals/top-level-technical-diagram.drawio
draw.io -x -o source/images/technical-flow-diagram.svg source/images/originals/technical-flow-diagram.drawio
```

Expand Down

0 comments on commit b2d21e4

Please sign in to comment.