Markdown guides

[saeed-moghimi-noaa]

@uturuncoglu @gseroka @mansurjisan @xuchengov

Hi team,

We'd like to suggest adding a new folder named 'guides' to this repository. This folder will be used to store guides in Markdown format.

Saeed Memari has prepared a guide on how to install Spack Stack on TACC Stampede that he would like to contribute to this new folder.

Please let us know your thoughts on this proposal.

Thanks!

[uturuncoglu]

@saeed-moghimi-noaa My personal opinion is to have only one place for the documentation. This could lower the maintenance cost and force us to keep documentation consistent. Since both model and run environment is changing day by day (for example we will have spack-stack 1.9.1 soon) it would be hard for us to update both Sphinx documentation and also markdown. Anyway, this is my feeling we could discuss it more in our regular meeting if you want. if you think that we definitely need it. Then, Saeed Memari could open a PR in the app level to bring that folder and the markdown doc.

[gseroka]

tagging @memarisa

[saeed-moghimi-noaa]

Hi @uturuncoglu

doc folder sounds good to me.

Thanks,
-Saeed

[saeed-moghimi-noaa]

@uturuncoglu

Would you please write down your clear suggestion and steps that Saeed need to take?

Thanks,

[uturuncoglu]

@saeed-moghimi-noaa We have some level of documentation for the porting model. Here is the link,

https://ufs-coastal-application.readthedocs.io/en/latest/PortingModel.html

If you think that we could add more to it. The best way is to editing following file

https://github.com/oceanmodeling/ufs-coastal-app/blob/main/doc/source/PortingModel.rst

If you follow the same structure in the document and add additional information. Then, we could compile the documentation and merge it if it looks okay. Other than this, if you would like to go with markdown approach. I think the best way is to add document to the wiki page,

https://github.com/oceanmodeling/ufs-coastal-app/wiki

It would be say to change without having PR in app level.

[memarisa]

Thanks @uturuncoglu @gseroka @saeed-moghimi-noaa
I added the containerized Spack-Stack 1.6.0 setup guide for UFS Coastal to PortingModel.rst.