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

[OUI Docs] Doc site header clean up #118

Closed

Conversation

bandinib-amzn
Copy link
Member

@bandinib-amzn bandinib-amzn commented Nov 9, 2022

Description

  1. Removed Figma, Codesandbox, Sketch link and icon.
  2. Removed Cascadia options and Babelfish from theme dropdown.
  3. Changed logoElastic to logoOUI.

Issues Resolved

#111

Screenshots

Header Changes

Before:

Screen Shot 2022-11-11 at 5 14 41 PM

After:
Screen Shot 2022-11-11 at 5 14 59 PM

Changed logoElastic to logoOUI

Before:

Screen Shot 2022-11-11 at 5 18 45 PM

After:

Screen Shot 2022-11-11 at 5 18 58 PM

The blank image is because of a reference to a broken image. @KrooshalUX will commit logo change which will resolve this. Also one UT is failing because of this reference to a broken image. This should also resolve.

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • All tests pass
    • yarn lint
    • yarn test-unit
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Bandini Bhopi <[email protected]>
Signed-off-by: Bandini Bhopi <[email protected]>
Signed-off-by: Bandini Bhopi <[email protected]>
Signed-off-by: Bandini Bhopi <[email protected]>
@bandinib-amzn bandinib-amzn marked this pull request as ready for review November 10, 2022 19:14
@bandinib-amzn bandinib-amzn requested a review from a team as a code owner November 10, 2022 19:14
Signed-off-by: Bandini Bhopi <[email protected]>
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

items: [
<OuiHeaderLogo iconType="logoElastic">Elastic</OuiHeaderLogo>,
],
items: [<OuiHeaderLogo iconType="logoOUI">Elastic</OuiHeaderLogo>],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should references to Elastic in these files be changed to OpenSearch, or is that out of the scope of this PR?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be OpenSearch UI, and this makes me think we actually need an OUI logo. The team has explored some options, we should put them forward

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BSFishy @kgcreative elastic reference removal is in my PR, and the OUI logo is in an upcoming PR. The to-do list on the original issue is accurate.

Copy link
Contributor

@KrooshalUX KrooshalUX Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, there may be merge conflicts between our PRs as I believe @bandinib-amzn originally included some of the elastic removal - I am not sure if those commits have been rolled back or not though. Will connect with @bandinib-amzn when I am not out of pocket.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KrooshalUX which elastic removal are we talking about? This PR includes only proposed changes from #111. Did I mistakenly remove other elastic reference? I'm not sure which commit needs to be rolled back.

@@ -237,7 +237,7 @@ const typeToPathMap = {
logoCouchbase: 'logo_couchbase',
logoDocker: 'logo_docker',
logoDropwizard: 'logo_dropwizard',
logoElastic: 'logo_elastic',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we keep this for the sake of backwards compatibility? Do we know if anyone else is using this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this change is in scope of this PR - there are several edits to the logos file that I am tracking as part of the meta issue for compliance.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per last task (Change logoElastic to logoOUI) from #111, I changed all logoElastic references to logoOUI. Does it mean that in this PR we should just update logoElastic to logoOUI and keep name of logo which is logo_elastic as it is in this PR?

@BSFishy
Copy link
Contributor

BSFishy commented Dec 30, 2022

Close in favor of #164

@BSFishy BSFishy closed this Dec 30, 2022
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.

5 participants