Feature: connector.yml

[lovromazgon]

We should extract the connector specifications into a YAML file instead of having it purely in Go code, to simplify use cases around extracting the data from specifications and using it in the connector readme or on conduit.io documentation pages.

Relevant discussion: #1522

Tasks

Generate connector.yaml (the specification file)

This section covers all the work related to generating a connector.yaml for a connector.

• Release v0.1.0 evolviconf#1
• Specgen conduit-connector-sdk#198 (specgen implementation, without tests)
• specgen: add more tests, rename connector to specification conduit-connector-sdk#206
• specgen: re-enable acceptance tests conduit-connector-sdk#210
• specgen: re-enable unit tests, benchmark tests, etc. conduit-connector-sdk#214
• specgen: Order fields (required first, then by name alphabetically) conduit-connector-sdk#209
• Export Paramgen conduit-commons#131

Documentation

This section covers documentation for the specgen tool itself.

• specgen: update README conduit-connector-sdk#208
• doc: document how connector specifications work conduit-site#198
• [WIP] readmegen: A utility for generating readme from specifications conduit-connector-sdk#115

Updates for new and existing connectors

This section covers work for updates related to new connectors (through our connector template) and existing connectors.

• specgen: generate specification from connector.yaml conduit-connector-template#57
• connector.yaml: validate Git tag and connector version conduit-connector-template#59
• connector.yaml: automatically push a tag when specification.version is changed conduit-connector-template#61
• Automate updates for existing connectors (specgen, readmegen)

Generate connector documentation on conduit.io

This section covers work for generating connector documentation (using the connector.yaml file) and putting it on our website.

• doc: Generate documentation page for each connector conduit-site#167