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

[Enhancement] Extend opensearchDashboards.branding.applicationTitle customization to app/opensearch_dashboards_overview #3049

Open
anubisg1 opened this issue Dec 8, 2022 · 10 comments
Assignees
Labels
branding enhancement New feature or request good first issue Good for newcomers help wanted Community development is encouraged

Comments

@anubisg1
Copy link

anubisg1 commented Dec 8, 2022

Describe the bug

when configuring brainding, and specifically opensearchDashboards.branding.applicationTitle , the string is not applied to the page app/opensearch_dashboards_overview

To Reproduce

  1. configure opensearchDashboards.branding.applicationTitle: 'something'
  2. open dashbaords home page and navigate to "https://<dashboard-url/app/opensearch_dashboards_overview"
  3. the title doesn't match the branding configuration

Expected behavior
Branding should be applied

OpenSearch Version
2.4.0

Dashboards Version
2.4.0

Screenshots

image

@anubisg1 anubisg1 added bug Something isn't working untriaged labels Dec 8, 2022
@joshuarrrr
Copy link
Member

@abbyhu2000 @kgcreative Is this intentional, or is this a string placement we missed in the original custom branding feature?

@kgcreative
Copy link
Member

kgcreative commented Dec 9, 2022

@joshuarrrr This feels like a missed string replacement.

@joshuarrrr joshuarrrr added good first issue Good for newcomers help wanted Community development is encouraged and removed untriaged labels Dec 9, 2022
@joshuarrrr
Copy link
Member

joshuarrrr commented Dec 9, 2022

Yeah, that tracks with the replacement areas highlighted in the original PR requirements. Anyone interested in fixing can also check out this PR for how specific title string replacements should work. #826

(See also the L3 location on that graphic as another potential title replacement location)

@abbyhu2000
Copy link
Member

@abbyhu2000 @kgcreative Is this intentional, or is this a string placement we missed in the original custom branding feature?

Yea it is intentionally excluded in the original custom branding project. When we drafted the original scope for custom branding, we discussed and decided to only include the 4 title strings that are highlighted in the PR description for title configuration for P0. (#826) We debated for a while on the specific occurrences of logos and titles in the application that should be allowed to customize, and came up with the list of 7 logos and 4 titles. The reason we decided to not include other title strings and logos for configuration is because we want to show that it is the wrapper around OpenSearch Dashboards that can be custom-branded, but we still want to keep the idea that OpenSearch Dashboards is the core functionalities, as for P0 of the project.

Should we consider adding more branding configurations now? @joshuarrrr @kgcreative @kavilla

@joshuarrrr
Copy link
Member

I don't think it's a matter of more configurations - just a matter of which strings can be customized with applicationTitle and which can't. Personally, I don't see much harm in extending the applicationTitle (given it's what @anubisg1 and other folks would prefer).

@joshuarrrr joshuarrrr added enhancement New feature or request and removed bug Something isn't working labels Dec 10, 2022
@joshuarrrr joshuarrrr changed the title [BUG] opensearchDashboards.branding.applicationTitle not applied to app/opensearch_dashboards_overview [Enhancement] Extend opensearchDashboards.branding.applicationTitle customization to app/opensearch_dashboards_overview Dec 10, 2022
@joshuarrrr
Copy link
Member

Updated the issue title and label to enhancement based on @abbyhu2000 's update.

@anubisg1
Copy link
Author

anubisg1 commented Dec 12, 2022

I don't think it's a matter of more configurations - just a matter of which strings can be customized with applicationTitle and which can't. Personally, I don't see much harm in extending the applicationTitle (given it's what @anubisg1 and other folks would prefer).

If i may, the reason why i reported this is because the actual home page has the application title changed, specifically here:

image

when a user clicks on "visualize and Analyze" he/she's then redirected to the page in question...
notice that the Icon remains branded, but not the application title.
As such, it looks like a miss (regardless if it was intentional or not) but more important it "breaks" the immerision provided by the branding and to a simple user (that has no idea of the configuration and what is supposed to change etc), it looks like a mistake

image

Therefore, in my opinion, this simple string should change when application title branding is applied

@abbyhu2000
Copy link
Member

@anubisg1 Thanks for call it out, and I can see how this might cause confusion for users. I also agree with @joshuarrrr that we can extend the title configuration to include the overview title. @kavilla What do you think?

@weily2
Copy link

weily2 commented Sep 5, 2024

image
image
image

The login page, overview page , side menu name will not be replaced after configure opensearchDashboards.branding.applicationTitle: 'something'

@weily2
Copy link

weily2 commented Sep 5, 2024

My opensearch-dashboards version is 2.15.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branding enhancement New feature or request good first issue Good for newcomers help wanted Community development is encouraged
Projects
None yet
Development

No branches or pull requests

6 participants