Oceananigans.jl icon indicating copy to clipboard operation
Oceananigans.jl copied to clipboard

Oceananigans "wiki" for hosting practical usage information

Open glwagner opened this issue 3 years ago • 4 comments

I opened a wiki for Oceananigans:

https://github.com/CliMA/Oceananigans.jl/wiki

I think we should use the wiki to host practical information and tips for using Oceananigans on various hardware (laptops, CPUs, GPUs), clusters / high-performance computing system (HPCs), and more.

Using the wiki this way will allow us to focus the docs on code and numerics, and alleviate the need to submit PRs to update details about using clusters.

We need to provide an introduction to Oceananigans "knowledge base" (where to find useful information in the documentation, wiki, Github Discussions, and Github Issues) in the README, the docs, and the wiki.

glwagner avatar Apr 24 '22 21:04 glwagner

Note that we have the option of opening up wiki editing to anyone on GitHub:

https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

so we should discuss that.

glwagner avatar Apr 24 '22 21:04 glwagner

Would we prefer to have anyone make a change to the wiki or perhaps post an issue and suggest that we add something to the wiki?

I am find with either but might have a slight preference for the latter.

francispoulin avatar Apr 25 '22 13:04 francispoulin

Who can edit? I guess those with repo write access, right?

navidcy avatar Apr 28 '22 21:04 navidcy

Yeah. I think we should let chaos reign for a little bit. Perhaps for big changes, we can open issues to discuss first.

glwagner avatar Apr 29 '22 02:04 glwagner

We have the wiki, so I'm closing.

glwagner avatar Mar 22 '23 17:03 glwagner