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.

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

Document DataSources (and DataSinks of course) #88

Closed
schuderer opened this issue Mar 23, 2020 · 0 comments · Fixed by #93
Closed

Document DataSources (and DataSinks of course) #88

schuderer opened this issue Mar 23, 2020 · 0 comments · Fixed by #93
Labels
docs Documentation related help wanted Extra attention is needed

Comments

@schuderer
Copy link
Owner

schuderer commented Mar 23, 2020

Although the documentation is getting more and more complete, we still lack more explicit documentation of the existing datasources/datasinks:

  • Name of the DataSource/DataSink (document those who belong together (e.g. FileDataSource/FileDataSink directly under each other if possible):
  • Is it included? -- or available externally (e.g. in examples), in which case specifying them with "plugins" is necessary.
  • What it is for, what it does
  • How to configure
  • How to use (including code example(s)).
  • Special features and considerations.

Ideally document all included datasources/sinks in a specific file docs/datasources.rst

Right now, some of their documentation is buried in the API documentation of the mllaunchpad.resource. Maybe there's a way to lift (part of) this API documentation from there into docs/datasources.rst

@schuderer schuderer added help wanted Extra attention is needed docs Documentation related labels Mar 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant