datashim-io / datashim

A kubernetes based framework for hassle free handling of datasets
http://datashim-io.github.io/datashim
Apache License 2.0
481 stars 68 forks source link

Feat: create a README that explains all the fields in a Dataset definition for S3/COS backend #365

Closed srikumar003 closed 3 months ago

srikumar003 commented 5 months ago

Is your feature request related to a problem? Please describe. We do not have a complete description of all the fields in a Dataset definition for each backend

Describe the solution you'd like Create a README file that walks through and explains how to define a Dataset for S3/COS and the effect of each option (e.g. readonly and provision)

Describe alternatives you've considered We currently have example files in the examples/ folder but with no documentation

srikumar003 commented 3 months ago

fixed for now by #356