README.md

Red Hat Diagrams in SVG

For any questions or help, please contact [email protected] & [email protected]

This repo is to facilitate collaboration on diagram content via git, and to create production ready SVG's.

Collaboration should happen in the source folder, get the optimized SVG from the for-web/ folder.

Folders & Purpose

Getting setup to optimize SVGs

! These instructions are written for Linux and Mac

First install Node JS on your system: https://nodejs.org/en/download/

Then open a terminal window, navigate to this folder and run:

npm install

This will install the tools needed to optimize the SVGs

Enabling automatic SVG optimization

To enable SVG optimization on every git commit (on your machine) run these two commands in this folder from the terminal:

cp .git-hooks/* .git/hooks/
chmod +x .git/hooks/*

This adds some commands that will run pre and post git commit to automatically optimize the SVG's for you.

Running SVG optimization manually

Run this command at any time to optimize all of the SVG's in the source/ folder, the result will be added to for-web/:

npm run build

Working with this repository as a designer

The process for working with Github to back up your work is documented here: https://docs.google.com/document/d/1zL_ukCnBpFHzqlUo9aO4IK8fIndYx5coyATl43d5Enw/edit?usp=sharing

Since the work is being reviewed outside of Git (currently email) the process for a designer creating new graphics is:

1. Create image in Illustrator

2. Save out SVG by going to File > Export > Export for Screens

3. Make sure it's exporting an SVG in the right column

4. Go to the Export Settings by clicking on the gear above the export types

5. Click SVG in the left column, then reproduce these settings:

6. For a new diagram create a new folder in this project under source/

7. Commit update (which should run SVG optimization and add it to for-web/)

8. Push up result