[PI] Docs: Potential Future Improvements Overview

[tkknight]

📚 Documentation

The Iris docs have been overhauled ready for the Iris 3.0.0 release but I have some ideas on how to improve more....

Small things

• [ ] The use of OVERRIDE_TEST_DATA_REPOSITORY is cited in the composed docs but not in the iris.config docstrings. Perhaps it should
• [ ] Update the release steps for maintainers to include a tweet announcement.
• [x] Review the Iris wiki on github (https://github.com/SciTools/iris/wiki). This has recently been disabled so the link no longer works. The content includes out of date info and some old release notes documentation.
• [ ] Review the steering council documentation, https://scitools.org.uk/organisation.html#organisation-top
• [x] #3885. Include a reference for WSL on the installing Iris page. Useful for users/devs who only have Windows 10, and it works great in my experience.

Ideas

• [ ] Use asciinema to capture some guides. Example for a user on singularity, see https://asciinema.org/~vs
• [x] Add a section for "Why Iris?"
• [ ] Add a section for a FAQ
• [ ] Add a Glossary
• [x] Consider adding more badges to the README or the docs themselves, where appropriate.

Sphinx extensions

• [x] Consider using if appropriate, https://github.com/djungelorm/sphinx-tabs? This is redundant as sphinx-panels supports this too.
• [x] #3884. Consider using if appropriate, https://sphinx-panels.readthedocs.io/en/latest/

[trexfeathers]

Include a reference for WSL on the installing Iris page. Useful for users/devs who only have Windows 10, and it works great in my experience.

I'd appreciate this. Haven't investigated fully yet but it appears that a Windows-Conda install can no longer build docs since common.metadata was added.

[tkknight]

I will draft a small PR for the WSL thing - I'm thinking just a one liner (or maybe a note) and use the link I gave in the issue overview

[trexfeathers]

@ESadek-MO could we close this and split any remaining work into independent issues?

[ESadek-MO]

I had created changes citing OVERRIDE_TEST_DATA_REPOSITORY in config.py, but on further thought I feel it's no longer appropriate; it's mentioned lower down in the config, albeit slightly vaguely, but I believe that's sufficent.