syndesisio / syndesis-ui-style-guide Archived

Syndesis UI Style Guide

This repository is to document the UI style guide for Syndesis development to try to ensure we have consistency through the UI, both to make it easier to contribute, but most importantly to have a consistent UX through Syndesis.

This style guide applies both to the main Syndesis UI and any modules that are imported to extend the functionality of the Syndesis.

Contributing

Simple :)

• Fork this repository
• Create a branch for your changes
• Hack on your changes - see below
• Send in a PR

Adding documentation

This repository uses asciidoc format for writing documentation. If you are unfamiliar with asciidoc, see here for syntax.

To build documentation run:

mvn clean install

Documentation is generated in target/generated-docs/index.html.

To get an updated build of documentation on changes, run:

mvn asciidoctor:http

You can then make changes to content and view changes at http://localhost:2000/.