-
Notifications
You must be signed in to change notification settings - Fork 8
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
Comments
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 |
For consistency and maintainability, i think we should have |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Currently we are using the
configuration-schema.json
to generate the sample configuration. We are checking therequired
list and then display a sample configuration based on the key we find in that required list. And for adaptors that do not haverequired
property we are showing all available properties on the sample configuration schema. See this PR for more details OpenFn/docs#492Request 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 createdconfiguration.md
file instead of generating the page usingsampleConfiguration()
functionThe text was updated successfully, but these errors were encountered: