Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a generic README template for new connectors #1020

Closed
izgeri opened this issue Nov 25, 2019 · 0 comments
Closed

Add a generic README template for new connectors #1020

izgeri opened this issue Nov 25, 2019 · 0 comments
Assignees
@izgeri
Labels
component/secretless-connectors kind/documentation

Comments

@izgeri
Copy link
Contributor

izgeri commented Nov 25, 2019 •
edited

The new connectors have templates, but the templates don't include a README (which we would expect as a requirement for an alpha / community contributed connector)

Add a README template to the template dirs. The template should include:

  • Description of covered use case
  • Known limitations
  • Supported versions of the client and target service
  • Supported configuration (with samples)
  • Whether SSL is supported for the secretless-to-server connection
  • Any other relevant information
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@izgeri izgeri

Labels
component/secretless-connectors kind/documentation
Milestone
No milestone
Development

No branches or pull requests
1 participant
@izgeri