NCAR / geocat-applications

GeoCAT Applications is a community resource inspired by the NCL Applications page.
https://ncar.github.io/geocat-applications/
Apache License 2.0
4 stars 5 forks source link

Expand Development Workflow #50

Open cyschneck opened 1 month ago

cyschneck commented 1 month ago

Expand Development Workflow Overview

Expand the documentation as a part of "For Developers > Contributor's Guide" to cover development workflow in greater depth (similar to depth in geocat-comp and uxarray)

Would be useful to make the instructions for different operating systems

For example, the command open does not function in Linux to open the index.html page as it does on Mac

If the `_build` folder is generated, but `open` command cannot open the html, you can navigate to the `index.html` document and right-click to `Open With` your desired browser.

Contributor's Guide

anissa111 commented 1 month ago

We should expand this issue to cover more than just the open command part. I'm not sure the bug template is necessarily the best fit for the intended scope, if that makes sense. Yes, there is technically a "bug", but it's a one or two line change in the broader scope of this ticket, which should talk about, for example, how we want to expand the section, what subsections we should have, how this section might need to be different than the version we have in geocat-comp, ect.

cyschneck commented 1 month ago

Agreed, something similar to how geocat-comp is set up: