ucphhpc / docker-migrid

Containerized MiG
GNU General Public License v2.0
3 stars 6 forks source link

Makefile: added test-doc #32

Closed benibr closed 1 year ago

benibr commented 1 year ago

This PR adds a Makefile target for checking if all used env vars are documented in the variables section in the docs.

This is also checked in the CI pipeline on Github

benibr commented 1 year ago

@jonasbardino Maybe you can add the last few variable explanations to the docs? Some of the Jupyter stuff is beyond my expertise. Search for "tba".

jonasbardino commented 1 year ago

I'm not aware of the MAIL_DOMAIN variable, is it used for the postfix container or perhaps a wrong name? @benibr

benibr commented 1 year ago

True, it doesn't seem to be used anywhere. I'll remove it within the next PR.