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

Make main page primary dashboard card logo and title configurable #766

Conversation

abbyhu2000
Copy link
Member

Description

US4: User can configure logo and title in the opensearch_dashboards.yml and see it in the application at run time for the primary dashboard card on the main page.

Screen Shot 2021-09-02 at 5 01 59 PM

Requirement:

User need to input a valid URL for opensearchDashboards.branding.smallLogoUrl and a valid string for opensearchDashboards.branding.title in the opensearch_dashboards.yml file.

Details:

  • If the URL is invalid or does not end with gif or svg, the default OpenSearch Dashboard logo will be shown. An application error log will be shown.
  • User can input URL with image of any size, and the image will be formatted to a fixed size.
  • User needs to be responsible for the content of the URL.
  • This is a local setting; user needs to set this config in all data nodes in OpenSearch Dashboards if a global setting is wanted.

Related Project Card:

https://github.com/abbyhu2000/OpenSearch-Dashboards/projects/1#card-68050198

Signed-off-by: Abby Hu abigailhu2000@gmail.com

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

Add one new config branding.loadingLogoUrl for making loading page logo
configurable. URL can be in svg and gif format. If no loading logo is found,
the static logo with a horizontal bar loading bar will be shown. If logo is also
not found, the default OpenSearch loading logo and spinner will be shown.

Signed-off-by: Abby Hu <abigailhu2000@gmail.com>
Dashboard primary card logo can be customized by config branding.smallLogoUrl
and title can be customized by branding.title. Also add title validation function
so the title length can only be between 1 - 36. Modify some legacy validation schema
so user input empty string will also render default OpenSearch branding.

Signed-off-by: Abby Hu <abigailhu2000@gmail.com>
@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed ee88a6e

@abbyhu2000
Copy link
Member Author

Screen Shot 2021-09-02 at 8 19 40 PM

@abbyhu2000 abbyhu2000 closed this Sep 22, 2021
@abbyhu2000 abbyhu2000 deleted the branding_dev_p0_us4_implementation branch July 28, 2022 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants