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

Generate documentation for connector specifications #114

Open
hariso opened this issue Apr 2, 2024 · 1 comment · May be fixed by #115
Open

Generate documentation for connector specifications #114

hariso opened this issue Apr 2, 2024 · 1 comment · May be fixed by #115
Labels
feature New feature or request

Comments

@hariso
Copy link
Contributor

hariso commented Apr 2, 2024

Feature description

Currently, the documentation related to connector specifications (source, destination parameters) that are part of the README is manually written.

We should automatically generate the documentation using a connector specification. The generation can be invoked using the paramgen tool.
@hariso hariso added feature New feature or request triage Needs to be triaged labels Apr 2, 2024
@github-project-automation github-project-automation bot moved this to Triage in Conduit Main Apr 2, 2024
@simonl2002 simonl2002 removed the triage Needs to be triaged label Apr 2, 2024
@simonl2002 simonl2002 removed this from Conduit Main Apr 2, 2024
@simonl2002
Copy link
Member

we'll take a look at this after 0.10

@hariso hariso linked a pull request Nov 20, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature or request
Projects
Conduit Roadmap
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[WIP] readmegen: A utility for generating readme from specifications ConduitIO/conduit-connector-sdk
2 participants
@simonl2002 @hariso