review hooks page

[boegel]

https://docs.easybuild.io/hooks/

[jkwmoore]

The example given in https://docs.easybuild.io/hooks/#manipulating-easyconfig-parameters looks suspect as self.cfg manipulation in the parse_hook shouldn't work.

Seems worth a correction with self.cfg.update('configopt', {'property': value})

---

Other thoughts about this page below:

Mostly as I am very rusty on Python but may also help people fairly new to Python, might be worth having this page include:

• A reminder that certain methods (e.g. .append .update) should be used with type of configuration objects (lists dicts).
• A highlight where self.cfg.update() vs self.cfg["configobject"].update() should will and won't work (in which hooks), and why you use them there.

Various additional possibly generic but real world often used hook examples might also be a good shout for the page:

• Adding log output to describe hook operations with self.log.info
• Setting license files or license servers.
• Enable SLURM / PSM2 / OFI / verbs etc... OpenMPI options.
• Adding additional buildopts
• Adding additional environment variables with modextravars
• Amending directory permissions for restricted software installations (or module files?) with post_permissions_hook and adjust_permissions()
• An example to set 32/64 bit for installations using the parse_hook and toolchainopts

[boegel]

I'll take a look at @jkwmoore's suggestions, some are not relevant anymore, but there's some great feedback in there.