RFC: Developer documentation
We've now got a setup where we can run tests locally as previously:
-
npm run test
ornpm yarn test
But to allow debugging of tests in the CI environment, we also have a dockerised test setup. This is run using:
-
npm run testci
oryarn run testci
However, it requires a bit of setup in advance, as documented on https://gitlab.coko.foundation/pubsweet/pubsweet-test-docker-baseimg. This isn't the only example of things developers should be aware of when working with our codebases.
We should document how developers should set up their environment for all this, and link to it from every README.
Thoughts on how to handle the developer docs in general? Should we have one repo with the docs in? Or put them in a wiki? Or a repo that generates a proper docs website?