-
Notifications
You must be signed in to change notification settings - Fork 913
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
fixing string placement in opensearch_dashboards_overview #3670
Conversation
Signed-off-by: Ilyas <[email protected]>
@mukatay1 can you fix the lint errors in the code and add a changelog entry for the change? |
Hi, yes I can. |
Signed-off-by: Ilyas <[email protected]>
Signed-off-by: Ilyas <[email protected]>
@ashwin-pc @abbyhu2000 Can you please review this pr? |
@@ -206,6 +206,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) | |||
- [Multi DataSource] UX enhancement on Data source management stack ([#2521](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2521)) | |||
- [Multi DataSource] UX enhancement on Update stored password modal for Data source management stack ([#2532](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2532)) | |||
- [Monaco editor] Add json worker support ([#3424](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3424)) | |||
- Fixing string placement in opensearch_dashboards_overview ([#3670](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3670)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor style nits - we prefer the imperative "use" or "fix" over "using" or "fixing". I also updated to be more reflective of the new feature.
- Fixing string placement in opensearch_dashboards_overview ([#3670](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3670)) | |
- [Overview] Use branding.applicationTitle as page header ([#3670](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3670)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your feedback and updates, I'll make sure to use the imperative form and keep the new feature in mind for future responses.
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## main #3670 +/- ##
==========================================
- Coverage 66.45% 66.44% -0.01%
==========================================
Files 3209 3209
Lines 61633 61634 +1
Branches 9506 9507 +1
==========================================
- Hits 40960 40955 -5
- Misses 18396 18400 +4
- Partials 2277 2279 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 3 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe we can just utilize the <DefaultMessage>
like below. The default is branding.applicationTitle is alreadyOpenSearch Dashboards
title={
<FormattedMessage
defaultMessage={branding.applicationTitle}
id="opensearchDashboardsOverview.header.title"
/>
}
defaultMessage="OpenSearch Dashboards" | ||
id="opensearchDashboardsOverview.header.title" | ||
/> | ||
) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mukatay1 What do you think of the above suggestion? It is aligned with previous application title configuration for the welcome title:
OpenSearch-Dashboards/src/plugins/home/public/application/components/welcome.tsx
Line 237 in 6b42669
defaultMessage={`Welcome to ${branding.applicationTitle}`} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its sounds great
@mukatay1 Do you think you are able to make changes to the PR based on the suggestions and also rebase this PR? |
@mukatay1 I'm converting this PR to a draft for now - when you have a chance to work on it again, you can take it out of draft mode. |
Description
The goal of this task is to enhance the readability and maintainability of the Overview component in the OpenSearch Dashboards project. By completing this task, the Overview component will be more maintainable, easier to understand, and adhere to the project's coding standards. This will facilitate future development and reduce the likelihood of introducing bugs or regressions.
Issues Resolved
Improved readability and maintainability of the Overview component
#3049
Check List
yarn test:jest
yarn test:jest_integration
yarn test:ftr