ExaWorks / SDK

ExaWorks SDK
11 stars 12 forks source link

Write documentation for container deployment #88

Closed mturilli closed 2 years ago

mturilli commented 2 years ago

Branch docs

kylechard commented 2 years ago

Ideally we want both user and developer documentation.

zekemorton commented 2 years ago

Hey @mturilli, I am just now getting to this. After looking at the documentation branch it looks like we are focusing in displaying our documentation via tutorials with Jupiter notebooks. I believe I can create a notebook with a bash kernel where I can go over usage of and development the sdk container. Is that what We were envisioning with this for the container deployment or something else entirely?

mturilli commented 2 years ago

Hey @zekemorton , thank you for looking into this. What we need to do is open to discussion but what you suggest seems useful to me.

zekemorton commented 2 years ago

@mturilli I went ahead and pushed my changes to docs let me know if you have any suggestions or want any changes!

This commit and affecting components.rst and docker.ipynb.

mturilli commented 2 years ago

LGTM!