Skip to content

Commit 5ff42b8

Browse files
authored
add tip to diagram lib page (#675)
* add tip * tips * finish fragment
1 parent 4310e77 commit 5ff42b8

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,16 +112,23 @@ Destinations: These files also include "intelligent partials", which are section
112112

113113

114114
## Formatting and Prettifying
115-
Some important tips! We also have a Styleguide available so you can see how different formatting looks when rendered.
115+
Some important tips! We also have a (rendering)[Formatting guide](/src/utils/formatguide.md) available so you can see how different formatting looks when rendered.
116+
117+
### Diagrams
118+
119+
We have a diagram library in sketch, which you can use to build pretty, on-brand architecture diagrams, etc. There's a [readme file in that directory](diagram-library/readme.md) with instructions on how to use it.
116120

117121
### Adding Images
118122

119123
**All images should be saved locally! No linking to 3rd party-hosted images!**
124+
120125
As CDN hosting is from the publish side, we shouldn't be worrying about that at the file level.
121126

122127
To add images to a docs page, create an `images` folder for the docs path, save the image to the folder and then reference it in your markdown file. The [Google Analytics destination](/src/connections/destinations/catalog/google-analytics) is a good example.
123128

124-
There are no naming conventions at this time. Anything you see with `asset` was dowloaded by a script to save it from Contents.io. :)
129+
There are no _enforced_ naming conventions at this time. Files that start with an underscore are ignored by jekyll. Anything you see with `asset` was dowloaded by a script to save it from Contents.io. :)
130+
131+
In general, it's a good practice to name images with a description that helps you figure out where they should go within a page, or within a larger folder of images. Naming with a prefix of what application the screenshot contains can be helpful (for example `atom-new-file.png`, `atom-commit-changes.png` etc), or you can name images to describe a process flow (for example `checkout-1-add-to-cart.png`, `checkout-2-est-shipping.png` and so on).
125132

126133
### Adding links
127134

diagram-library/readme.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ You can also export the file, or diagrams you make with it, to `.svg` format for
2121
8. At the VERY end of the panel, find the **Export Selected** button, and click it.
2222
9. If needed, move the resulting `.png` file to the correct `images` directory.
2323
10. Add the new diagram in the markdown file, and run a test build to make sure your diagram is legible on the page!
24+
(Don't forget to add the file in git!)
2425

2526
That's it!
2627

@@ -30,3 +31,7 @@ When you need to update the images, you can reopen the Sketch file, make your ch
3031
## Adding new items to the Library
3132

3233
Contact @sanscontext for instructions. :)
34+
35+
## More reading on diagrams and diagram best practices
36+
37+
https://blog.ilograph.com/posts/diagram-mistakes/

0 commit comments

Comments
 (0)