DOC: Add suitcase-cookiecutter

bluesky / suitcase-core

data export facilities for NSLS-II

https://blueskyproject.io/suitcase

Other

2 stars 13 forks source link

DOC: Add suitcase-cookiecutter #77

Open ke-zhang-rd opened 4 years ago

ke-zhang-rd commented 4 years ago

This PR

Add suitcase-cookiecutter to doc
Fix file_prefix formate to match source code like here https://github.com/bluesky/suitcase-csv/blob/master/suitcase/csv/__init__.py#L212

danielballan commented 4 years ago

I am slightly against listing the cookiecutter alongside the list of formats because I think it would be confusing to people who are trying to find what formats we support and do not know what a "cookiecutter" is.

jklynch commented 4 years ago

I assume the suitcase-core sphinx docs are staying?

ke-zhang-rd commented 4 years ago

I assume the suitcase-core sphinx docs are staying?

Yes, and it will be centralized docs.

ke-zhang-rd commented 4 years ago

I am slightly against listing the cookiecutter alongside the list of formats because I think it would be confusing to people who are trying to find what formats we support and do not know what a "cookiecutter" is.

Then how about in step 2 of Create the package with cookiecutter ? You could pick a location.

jklynch commented 4 years ago

There could be a "!Note" in "Create the package with cookiecutter" explaining briefly what cookiecutter is and linking to the suitcase-cookiecutter repository.