openstack/openstack-manuals
Code Issues Proposed changes
openstack-manuals/doc/doc-contrib-guide/source/diagram-guidelines/tools.rst
Alexandra Settle 85107272be [contrib-guide] Updating url to doc-contrib-guide 
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +00:00

980 B
Raw Blame History

Tools

There are many tools you can use to create a diagram, and contributors are free to use the tool of their choice.

However, elements within a diagram must be easily edited or easy to reproduce with a different tool. Follow the file saving conventions outlined in dg_files. This ensures that a diagram can be reviewed and edited as OpenStack projects continue to change.

Open source tools can help streamline the review process by making diagrams easy to edit. Many open-source tools contain shapes and stencils that can be used in OpenStack. The following is a list recommended open source tools:

  • Draw.io: Draw.io contains most of the customization options needed to make diagrams. Diagrams can also be saved as an .svg file, which allows contributors to edit individual elements of each diagram.