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

Create a configuration.md file for each adaptor #572

Open
mtuchi opened this issue May 20, 2024 · 2 comments
Open

Create a configuration.md file for each adaptor #572

mtuchi opened this issue May 20, 2024 · 2 comments

Comments

@mtuchi
Copy link
Collaborator

mtuchi commented May 20, 2024

Description

Currently we are using the configuration-schema.json to generate the sample configuration. We are checking the required list and then display a sample configuration based on the key we find in that required list. And for adaptors that do not have required property we are showing all available properties on the sample configuration schema. See this PR for more details OpenFn/docs#492

Request in few words

Create a configuration.md that will be used to document sample configuration and the full configuration-schema.
Once this is done, update OpenFn/docs to use the newly created configuration.md file instead of generating the page using sampleConfiguration() function

@josephjclark
Copy link
Collaborator

We don't need to do it for every adaptor - just those for whom "Show all properties" and "show all required properties" is not helpful (like http).

Basically we want the OPTION to manually define a sample configuration

@mtuchi
Copy link
Collaborator Author

mtuchi commented May 21, 2024

For consistency and maintainability, i think we should have configuration.md for all adaptors if we decided to go with this approach

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Icebox
Development

No branches or pull requests

2 participants