Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UX] Switch to condensed global header by default #1834

Open
joshuarrrr opened this issue Jun 30, 2022 · 6 comments
Open

[UX] Switch to condensed global header by default #1834

joshuarrrr opened this issue Jun 30, 2022 · 6 comments

Comments

@joshuarrrr
Copy link
Member

joshuarrrr commented Jun 30, 2022

In v2.1.0, we introduced a new, condensed version of the global header that administrators can enable by setting OpensearchDashboards.branding.useExpandedMenu to false. For the next breaking release (v3.0.0), we plan to switch the default to true, while still allowing customers to opt-out of the new experience (for now) by explicitly setting the config to false.

We should also mark useExpandedMenu as deprecated, so that we can drop support for the expanded header in v4.0.0.

@joshuarrrr
Copy link
Member Author

@dagneyb @KrooshalUX @wbeckler This was tagged for v3.0 because it was identified as a breaking change (specifically for Bitergia, which would need to actively set the config option for their plugin to continue working as expected: opensearch-project/oui#807 (comment)

Does this plan need reconsidering given current work toward #4298?

@wbeckler
Copy link

I'm not sure I understand the relevance of the conversation in opensearch-project/oui#807 (comment)

Did Bitergia specify something they are relying on with respect to the 2.x fonts and styles?

@joshuarrrr
Copy link
Member Author

No - Bitergia is the community partner that this particular change is known to be breaking for (although it may also break others). The question is whether there's greater urgency to change the default header behavior as part of the look and feel updates.

The reason I referenced the thread is that the look and feel design work is specifically targeting the condensed global header design, but that's not the default experience for even new users because of this issue.

@wbeckler
Copy link

wbeckler commented Jul 2, 2023

Is there a way that a plugin can set the default back to false if the default were true, and that would make life easier for a plugin that wasn't ready for a larger change? Meanwhile, don't minor releases require lots of plugin updates?

@joshuarrrr
Copy link
Member Author

Is there a way that a plugin can set the default back to false if the default were true, and that would make life easier for a plugin that wasn't ready for a larger change?

I can't think of a reasonable way for that to work - the YAML config is under the control of the admin, not a plugin interface for writing. And it's a bit of a pandora's box - how do you resolve the value if you try to load two plugins, each with a different requirement of the setting?

In this case, I think the most reasonable change is for Bitergia (or other plugins) to add a documentation/installation note.

Meanwhile, don't minor releases require lots of plugin updates?

Generally no. The OpenSearch Dashboards team has bent over backwards to make sure minor releases generally require zero plugin updates or changes.

@evamillan
Copy link
Contributor

In case it helps, this is how we use the header in our plugin:

image

We add the name of the current tenant and a menu to navigate the dashboards using the navControls methods.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

3 participants