spack-tutorial icon indicating copy to clipboard operation
spack-tutorial copied to clipboard

Package Creation tutorial has too much beginner stuff

Open adamjstewart opened this issue 2 years ago • 4 comments

The Package Creation tutorial has a long section on setting SPACK_ROOT, PATH, and EDITOR, sourcing the setup script, etc. At this point in the tutorial, we've done this a million times, no need to specify this again. In fact, things like EDITOR should be moved to earlier points in the tutorial.

adamjstewart avatar Nov 13 '22 20:11 adamjstewart

I agree too much beginner stuff left in it BUT I think we should at least have a pointer to that kind of information to cover the case of someone starting with that section of the tutorial.

tldahlgren avatar Nov 13 '22 20:11 tldahlgren

Is there a way in sphinx to have a collapsible section? That might be perfect for this

becker33 avatar Nov 13 '22 21:11 becker33

Is there a way in sphinx to have a collapsible section? That might be perfect for this

Great idea! And there is a collapse feature: https://sphinx-toolbox.readthedocs.io/en/stable/extensions/collapse.html

tldahlgren avatar Nov 14 '22 19:11 tldahlgren

If we do collapse it for beginner, we should collapse it for all tutorials. Or only in the first tutorial where we need it.

adamjstewart avatar Nov 14 '22 19:11 adamjstewart

This no longer seems to be an issue.

adamjstewart avatar May 11 '24 16:05 adamjstewart