E3SM-Project / Omega

Next generation ocean model within E3SM
https://docs.e3sm.org/Omega/omega
Other
4 stars 5 forks source link

corrected paths for quick start: mesh symlinks #158

Closed alicebarthel closed 2 weeks ago

alicebarthel commented 2 weeks ago

The Omega quick start guide had a minor mistake in the command for the meshes symlinks. Correct syntax is: ln -sf ../global_test_mesh.nc test/OmegaSphereMesh.nc or

cd test
ln -sf  ../global_test_mesh.nc OmegaSphereMesh.nc

I proposed the latter because of its readability.

Also corrected minor typos in BuildDocs

Checklist

alicebarthel commented 2 weeks ago

Note that the link to "build locally" in the PR template is broken. The correct path is: https://docs.e3sm.org/Omega/omega/develop/devGuide/BuildDocs.html

xylar commented 2 weeks ago

@alicebarthel, could you fix that issue here as part of this PR as well? https://github.com/alicebarthel/E3SM/blob/omega-doc-correction/.github/pull_request_template.md?plain=1#L14

alicebarthel commented 2 weeks ago

Thanks for pointing out the template @xylar, I failed to find it! Should I be concerned about the linter failures?

xylar commented 2 weeks ago

Should I be concerned about the linter failures?

No, I was trying to figure out how to fix those -- it was linting files that at shouldn't have been. But now they're gone!

alicebarthel commented 2 weeks ago

Thanks @xylar. I saw that they magically disappeared! Thanks for resolving these.