Added a glossary for Iris docs. #4902
Conversation
…t to group decision.
ESadek-MO
force-pushed
the
iris-glossary
branch
from
5a64c05 to
85d9531
Compare
trexfeathers
left a comment
trexfeathers
left a comment
There was a problem hiding this comment.
Super job @ESadek-MO! I've added some minor comments. It would also be great to see NetCDF, GRIB, PP and FF formats mentioned.
|
Added Table Of Contents; done manually as couldn't seem to find an appropriate automatic version. Its inclusion is up for discussion; might be unnecessary or too lengthy, and might be negated by the use of Ctrl F. Newer definitions (each file format, xarray and coordinate factory) could perhaps do with some tinkering. Appropriate "more information" links might also need more work, currently some third party sites are used. Perhaps @pp-mo might have some insight? There is potential to add links to the glossary from the docs, included as the docs are organically updated themselves, but for the time being the existence of the glossary should suffice. There is also potential of examples being added to definitions, although I fear this might disrupt the brevity. A separate page of examples, linked from the glossary, could be a solution to this, but would require more work and perhaps end up too disjointed. |
|
Removed TOC, replaced with alphabetical links. Perhaps needs better formatting, and a fair amount of letters are currently unused, and as such messy. |
|
Hopefully final edit (excluding reviews); done away with any sort of table of contents, alphabetical or non. It just appeared to be too messy, no nice way of doing it. Older version remain in prior commits, but unless a mass vote to revert I think this is final version for the time being. |
trexfeathers
left a comment
trexfeathers
left a comment
There was a problem hiding this comment.
This is looking really good @ESadek-MO, great job! Please could you add a What's New entry and I'll merge.
There was a problem hiding this comment.
Great work ! I especially like the extensive cross-linking.
Meanwhile on my account .. A lot of fiddling changes, more- or less-important.
Not an ideal way of raising them. I'm now thinking, so if it's all too fiddly please merge the initial, and I will re-propose them in a separate PR where they could be discussed separately.
pp-mo
left a comment
pp-mo
left a comment
There was a problem hiding this comment.
As promised : decouple the text in term refs from the exact Glossary name
pp-mo
left a comment
pp-mo
left a comment
There was a problem hiding this comment.
Sorry, I didn't finish the job + it makes a bit of a mess.
Hopefully these suggestions make it complete (but you should see on build)
…f small changes, so going to have to go through and test I haven't broken anything
…about units definition, but not an urgent change
|
Hopefully ready for approval. |
|
Over to you, @pp-mo |
|
Many Thanks @ESadek-MO and sorry for repeated change requests ! |
|
Possible Additions in future: Other things we might consider in the glossary |
3 participants
🚀 Iris Glossary
Description
Created a glossary of terms for iris docs, currently located within user guide. Intended to just be a quick lookup, with links to other relevant terms and also the more in depth docs documents.
Most everything at this point is susceptible to change; please feel free to suggest new terms, removal of terms, editing or (hopefully not needed) correcting of definitions, and formatting changes.
Current Build: https://esadek-mo-irisdocs.readthedocs.io/en/latest/userguide/glossary.html