carpentries-incubator
Wiki for documenting release process
We want to have a central record of the process for making releases (and other documentation), that is associated with the repository, but isn't overfilling the readme file.
Aleks' documented process for releases at: https://github.com/carpentries-incubator/python-intermediate-development/issues/472
Where would this wiki live? It is also common to document this type of information in a README.dev.md file. Then at least it is version-controlled along with the rest of the code, in case the release process changes. Maintaining a separate wiki, can be cumbersome and will most likely lead to divergence between the source code and the process described in the wiki.
Sorry for the slow reply. The wiki will be attached to this repository (see https://github.com/carpentries-incubator/python-intermediate-development/wiki/Release-Process). I agree that most documentation would be best kept next to the codebase. However this release process is for long-term archival and referencing purposes, rather than for publishing the material through the carpentries interface, and it is also independent of the carpentries build system. So I think a wiki is an appropriate documentation method in this instance.