Created documentation for UX changes #6595

ESadek-MO · 2025-07-31T10:59:36Z

🚀 Pull Request

Related #4799
Closes #6498

Left to do:

~~Add mention of the cultural changes we wish to see~~ Minutes removed from PR
~~Double check the minutes make sense~~ Minutes removed from PR
(Once merged) Add a reference to the docs in Iris User Experience #6594

codecov · 2025-07-31T11:15:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.00%. Comparing base (b62c743) to head (8ef66ed).
⚠️ Report is 64 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6595      +/-   ##
==========================================
+ Coverage   89.89%   90.00%   +0.11%     
==========================================
  Files          90       91       +1     
  Lines       24138    24447     +309     
  Branches     4492     4567      +75     
==========================================
+ Hits        21699    22004     +305     
+ Misses       1679     1676       -3     
- Partials      760      767       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

trexfeathers · 2025-07-31T11:16:57Z

docs/src/further_topics/user_experience/index.rst

Could I suggest referencing this in the new Iris Philosophy page?

iris/docs/src/userguide/iris_philosophy.rst

Lines 1 to 5 in deaaab9

.. _iris-philosophy:

****************

Iris' Philosophy

****************

I don't know if it's possible to literally include some of the text from user_experience/index.rst but that would be good if we could.

I.e. via some sort of directive so that changing the text in 1 place changes both.

Actually, having finished my review, which includes suggesting that minutes remain within GitHub. In that situation I think the content you are introducing would make an ideal addition to the Philosophy page, rather than adding any new pages/sections.

What do you think?

We said we wouldn't mess with the Philosophy page, but I think adding a reference like what was originally suggested is still relevant.

The single directive approach seems possible using MyST substitutions, albeit a bit round the houses. I can't find a way to do it via sphinx though, so I'll do it manually.

trexfeathers · 2025-07-31T13:34:22Z

docs/src/further_topics/user_experience/ux_past_discussions/ux_discussion_02-05-25.rst

Granted, we should definitely be more public with minutes from meetings.

But minuting stuff in our documentation would be quite a departure from the norm. I would prefer that the documentation remain a 'user manual'; this means that wherever possible it is our official, unambiguous word, with no speculation/conversation.

GitHub is the ideal place for looser, less curated conversation. I would like to see more items like #5165 (comment) on our repo; this seems to be in a similar vein. Note this comment:

Note this issue is not intended as a debate, hence why it is not posted as a discussion. The below conversations took place in real time, with a group deliberately sized to aid decision making.

As the above implies, the default should probably be Discussions, not Issues. We could perhaps create a new discussions category for minutes, if this is something we aim to do more of?

I suppose that might simplify things by making this a single page, rather than a section?

Yeah I'm happy with that. Especially since there's already a UX discussion, the minutes could be added there, or linked at least.

trexfeathers · 2025-07-31T13:37:09Z

docs/src/further_topics/user_experience/ux_past_discussions/ux_discussion_02-05-25.rst

+* It might also be that Iris' user base is largely Met Office employees, who would rely on
+  support and Viva Engage. We *DO NOT* think that we should put more focus onto Met Office
+  employees, as that would skew the balance and dissuade further users from joining us.


I am comfortable sharing things like this, but it needs to make sense to all readers. Phrases like UK Met Office and internal message boards

trexfeathers · 2025-07-31T13:38:34Z

docs/src/further_topics/user_experience/ux_past_discussions/ux_discussion_02-05-25.rst

+We do currently have the Community tab, which includes valuable documentation for xarray and
+pandas documentation. This is hard to find however, and misses links for things such as
+GeoVista and ncdata. We think this should be more immediate, or less buried. We also wonder
+if we should sell Iris as both a complete product *and a toolbox*, for using with xarray.


I think this was supposed to be "a tool in a toolbox"

trexfeathers · 2025-07-31T13:43:12Z

docs/src/further_topics/user_experience/index.rst

+..note ::
+    If you have any thoughts or comments on either the user experience of Iris, or on this page,
+    please create a GitHub discussion, or comment in an existing one! We'd love to hear from you!


Suggested change

..note ::

If you have any thoughts or comments on either the user experience of Iris, or on this page,

please create a GitHub discussion, or comment in an existing one! We'd love to hear from you!

.. note::

If you have any thoughts or comments on either the user experience of Iris, or on this page,

please create a GitHub discussion, or comment in an existing one! We'd love to hear from you!

trexfeathers · 2025-07-31T13:50:28Z

docs/src/further_topics/user_experience/ux_guide.rst

+
+Below are some potential topics to guide future discussions on the Iris user experience.
+
+..note ::


Suggested change

..note ::

.. note::

trexfeathers · 2025-07-31T13:55:10Z

docs/src/further_topics/user_experience/index.rst

Actually, having finished my review, which includes suggesting that minutes remain within GitHub. In that situation I think the content you are introducing would make an ideal addition to the Philosophy page, rather than adding any new pages/sections.

What do you think?

ESadek-MO · 2025-07-31T14:20:03Z

@trexfeathers

I agree with most comments here, the minutes page I had forseen being a bit of a mess anyway, and putting it as a discussion seems wise.

Adding the discussion guide to Philosophy feels a little crammed in. I could happily be vetoed, my feelings aren't strong, but it feels a bit like it's not so much a philosophy as it is guiding a process. The philosophy would be "we're having regular meetings, because".

trexfeathers · 2025-07-31T14:25:13Z

Adding the discussion guide to Philosophy feels a little crammed in. I could happily be vetoed, my feelings aren't strong, but it feels a bit like it's not so much a philosophy as it is guiding a process. The philosophy would be "we're having regular meetings, because".

Yes I see your point, let's not mess with the Philosophy page

…ting

ESadek-MO added 5 commits July 30, 2025 14:46

created a landing page for iris ux docs

d31ca75

created a guide for users and devs to think about UX

37f9287

Added a precursory "minutes" of our first meeting.

bc5a75c

added link to mega discussion

f1a1706

fixed doctest failures

28e7a90

trexfeathers reviewed Jul 31, 2025

View reviewed changes

trexfeathers self-assigned this Jul 31, 2025

some formatting fixes

df5c639

trexfeathers requested changes Jul 31, 2025

View reviewed changes

scitools-ci bot added this to 🚴 Peloton Aug 1, 2025

ESadek-MO added 2 commits August 13, 2025 08:20

removed minutes, consolidated into one file, fixed wording and format…

e49161f

…ting

added reference to philosophy page

8ef66ed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Created documentation for UX changes #6595

Created documentation for UX changes #6595

Uh oh!

ESadek-MO commented Jul 31, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jul 31, 2025 •

edited

Loading

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

ESadek-MO Aug 13, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

ESadek-MO Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

trexfeathers Jul 31, 2025

Uh oh!

ESadek-MO commented Jul 31, 2025

Uh oh!

trexfeathers commented Jul 31, 2025

Uh oh!

Uh oh!

	.. _iris-philosophy:

	****************
	Iris' Philosophy
	****************


		Below are some potential topics to guide future discussions on the Iris user experience.

		..note ::

Created documentation for UX changes #6595

Are you sure you want to change the base?

Created documentation for UX changes #6595

Uh oh!

Conversation

ESadek-MO commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Pull Request

Uh oh!

codecov bot commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ESadek-MO commented Jul 31, 2025

Uh oh!

trexfeathers commented Jul 31, 2025

Uh oh!

Uh oh!

ESadek-MO commented Jul 31, 2025 •

edited

Loading

codecov bot commented Jul 31, 2025 •

edited

Loading