openenergysolutions / openfmb.adapters

OpenFMB Adapters
Apache License 2.0
3 stars 1 forks source link

Mkdocs Adapter Documentation #84

Closed jadamcrain closed 4 years ago

jadamcrain commented 4 years ago
  1. Create a user guide using the MkDocs markdown to HTML documentation generator.

a. Explain how the adapter works as it would be relevant to a user (i.e. how plugins publish and subscribe to profiles internally).

b. Explain the topmost configuration YAML and list of plugins.

c. Explain the difference between the OpenFMB native plugins (DDS, MQTT, NATS) and the legacy protocol conversions.

d. Explain the protocol independent configuration aspects for profiles, i.e. constants, generated values, mapped values, etc. Explain how the configuration tree mirrors the protobuf structure.

e. Provide detailed guides for each plugin. Where multiple options are possible depending on the value of an enumeration, leverage the “tab” functionality available in the CodeHilite extension to provide a tab containing the required configuration values for each possible option. Document the meaning and valid ranges of all configuration values.