selfdescribe

Documentation

Overview

Package selfdescribe contains code that knows how to pull metadata from various agent component out into a well structured format that can be fed into other workflows to generate documentation or other resources such as chef recipies. The main interface is the JSON() function, that returns everything encoded as JSON.

Index

• func JSON() string

Functions

func JSON

func JSON() string

JSON returns a json encoded string of all of the documentation for the various components in the agent. It is meant to be used as an intermediate form which serves as a data source for automatically generating docs about the agent.