OpenLineage / docs

Documentation and website for OpenLineage
https://openlineage.io
11 stars 24 forks source link

Improve transport configuration docs #319

Closed dolfinus closed 7 months ago

dolfinus commented 7 months ago
netlify[bot] commented 7 months ago

Deploy Preview for mellifluous-eclair-326dcd ready!

Name Link
Latest commit ef10d234e7940f2c4e2200ca3b3c610e61649bbd
Latest deploy log https://app.netlify.com/sites/mellifluous-eclair-326dcd/deploys/6620ed07912bb20008ad195b
Deploy Preview https://deploy-preview-319--mellifluous-eclair-326dcd.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dolfinus commented 7 months ago

Regarding Java & Python code examples for each transport - this is probably should be moved somethere to javadoc/docstrings, to keep examples close to the code

kacpermuda commented 7 months ago

Regarding Java & Python code examples for each transport - this is probably should be moved somethere to javadoc/docstrings, to keep examples close to the code

IMHO we should not remove them from the docs, but we can always add a doc reference in the docstrings, so the users can quickly see the examples. We could copy those examples, but then keeping them in sync can be a pain.