Documentation

You can generate documentation for an application with the command-line command doc. It writes a markdown file to stdout, which contains the interlinked descriptions of the parts. At the application and part level the fields title and description are the sources of the documentation. For aggregate commands those fields are also used.

The dot command-line command generates a dot file on stdout. It is a visual graph of how the Kafka topics and streams are connected. If you install the Graphviz command-line tool then generating a graph in SVG, for example, can be done like this:

> js dot -a <my-application> | dot -Tsvg > my-application.svg

Both the doc and dot commands have the option -d, --directory. Instead of writing to stdout they will write to the given directory, using the application name to construct the filename in them.

When the commands are run without any options, they will run for all deployed applications.