[CCI] Normalize interlink URL usage #720

SergeyMyssak · 2023-04-18T01:53:58Z

Description

Normalized interlink URL usage

Issues Resolved

#698

Check List

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.

SergeyMyssak · 2023-04-18T01:58:24Z

Hello @KrooshalUX, I replaced all /1.0/ references with /latest/. I have also changed google.com and opensearch.org in some places, could you please check whether I should keep these changes or undo them?

SergeyMyssak · 2023-04-18T02:41:37Z

src-docs/src/views/badge/badge_example.js

+const badgeHrefSnippet = [
+  '<OuiBadge href="https://oui.opensearch.org/latest/" />',
+];


src-docs/src/views/badge/beta_badge.js

src-docs/src/views/button/button_as_link.js

SergeyMyssak · 2023-04-18T02:51:13Z

src-docs/src/views/call_out/danger.js

+      <OuiLink href="https://oui.opensearch.org/latest/">
+        this link can help
+      </OuiLink>
+      .


The links in the call outs should go to https://opensearch.org/docs/latest/

Made the changes according to the comment

src-docs/src/views/text/text.js

SergeyMyssak · 2023-04-18T03:32:06Z

src-docs/src/views/text/text_color.js

@@ -68,7 +68,7 @@ export default () => (
        Sometimes you need to color entire blocks of text, no matter what is in
        them. You can always apply color directly (versus using the separated
        component) to make it easy. Links should still{' '}
-        <a href="#">properly color</a>.
+        <a href="https://oui.opensearch.org/latest/">properly color</a>.


SergeyMyssak · 2023-04-18T03:32:38Z

src-docs/src/views/toast/success.js

+      <OuiLink href="https://oui.opensearch.org/latest/">
+        here&rsquo;s a link
+      </OuiLink>
+      .


SergeyMyssak · 2023-04-18T03:33:16Z

src-docs/src/views/toast/toast_list.js

+              <OuiLink href="https://oui.opensearch.org/latest/">
+                here&rsquo;s a link
+              </OuiLink>
+              .


Lets use https://opensearch.org/docs/latest/ for this demo.

Made the changes according to the comment

SergeyMyssak · 2023-04-18T03:35:17Z

src-docs/src/views/tool_tip/tool_tip.js

@@ -27,7 +27,7 @@ export default () => (
      <p>
        This tooltip appears on the{' '}
        <OuiToolTip position="top" content="Here is some tooltip text">
-          <OuiLink href="#">top</OuiLink>
+          <OuiLink href="https://oui.opensearch.org/latest/">top</OuiLink>


These should not be links, the # is on purpose to show a tooltip only.

Reverted changes

SergeyMyssak · 2023-04-18T03:52:51Z

src-docs/src/views/accessibility/screen_reader.tsx

+          <OuiLink href="https://oui.opensearch.org/latest/">
+            Skip navigation
+          </OuiLink>


This skip navigation link is a demonstration of an accessibility tool, and should not have the URL associated with it.

Reverted changes

SergeyMyssak · 2023-04-18T03:54:23Z

src-docs/src/views/key_pad_menu/key_pad_beta.js

+    <OuiKeyPadMenuItem
+      label="Dashboard"
+      href="https://oui.opensearch.org/latest/">
      <OuiIcon type="dashboardApp" size="l" />
    </OuiKeyPadMenuItem>

    <OuiKeyPadMenuItem
      label="Dashboard"
-      href="#"
+      href="https://oui.opensearch.org/latest/"
      betaBadgeLabel="Experimental"
      betaBadgeTooltipContent="This module is not GA. Please help us by reporting any bugs.">
      <OuiIcon type="dashboardApp" size="l" />
    </OuiKeyPadMenuItem>

    <OuiKeyPadMenuItem
      label="Dashboard"
-      href="#"
+      href="https://oui.opensearch.org/latest/"


SergeyMyssak · 2023-04-18T03:55:46Z

src-docs/src/views/key_pad_menu/key_pad_menu.js

+    <OuiKeyPadMenuItem
+      label="Dashboard"
+      href="https://oui.opensearch.org/latest/">
      <OuiIcon type="dashboardApp" size="l" />
    </OuiKeyPadMenuItem>

-    <OuiKeyPadMenuItem label="Dashboard" href="#">
+    <OuiKeyPadMenuItem
+      label="Dashboard"
+      href="https://oui.opensearch.org/latest/">
      <OuiIcon type="dashboardApp" size="l" />
    </OuiKeyPadMenuItem>

-    <OuiKeyPadMenuItem label="Dashboard" href="#">
+    <OuiKeyPadMenuItem
+      label="Dashboard"
+      href="https://oui.opensearch.org/latest/">
      <OuiIcon type="dashboardApp" size="l" />
    </OuiKeyPadMenuItem>

-    <OuiKeyPadMenuItem isDisabled label="Dashboard" href="#">
+    <OuiKeyPadMenuItem
+      isDisabled
+      label="Dashboard"
+      href="https://oui.opensearch.org/latest/">
      <OuiIcon type="dashboardApp" size="l" />
    </OuiKeyPadMenuItem>


SergeyMyssak · 2023-04-18T03:56:05Z

src-docs/src/views/key_pad_menu/key_pad_menu_example.js

+  <OuiKeyPadMenuItem label={label1} href="https://oui.opensearch.org/latest/">
    <OuiIcon type={icon1} size="l" />
  </OuiKeyPadMenuItem>
-  <OuiKeyPadMenuItem label={label2} href="#">
+  <OuiKeyPadMenuItem label={label2} href="https://oui.opensearch.org/latest/">


SergeyMyssak · 2023-04-18T03:56:20Z

src-docs/src/views/key_pad_menu/key_pad_menu_example.js

@@ -51,7 +51,7 @@ const keyPadBetaSource = require('!!raw-loader!./key_pad_beta');
 const keyPadBetaHtml = renderToHtml(KeyPadBeta);
 const keyPadBetaSnippet = `<OuiKeyPadMenuItem
  label={label}
-  href="#"
+  href="https://oui.opensearch.org/latest/"


SergeyMyssak · 2023-04-18T03:57:23Z

src-docs/src/views/list_group/list_group_item_color.tsx

+        href="https://oui.opensearch.org/latest/"
+        label="Ghost"
+        color="ghost"
+      />


KrooshalUX · 2023-04-18T20:52:38Z

@SergeyMyssak Thanks for the detailed look into this issue. I have commented on the changes where linking to OpenSearch Dashboard documentation was on purpose. There are a few other minor bits of feedback for the areas where previously a # was used in place of a URL as well.

BSFishy

There are some instances where I'm not sure if it makes sense to redirect all the way to the OUI docs page, I feel like in certain places a plain # href is sufficient. Pinging @KrooshalUX again to take a second look after changes

KrooshalUX · 2023-04-27T21:05:03Z

@BSFishy I could be aligned with that- I think my main concern is just being able to demonstrate to non-engineering viewers of the documentation that links are supported. I am not sure # would communicate that on mouse over as well as an actual link - but - for the sake of simplicity I am ok if we go that route.

SergeyMyssak · 2023-05-03T02:31:50Z

@BSFishy I could be aligned with that- I think my main concern is just being able to demonstrate to non-engineering viewers of the documentation that links are supported. I am not sure # would communicate that on mouse over as well as an actual link - but - for the sake of simplicity I am ok if we go that route.

Hello @KrooshalUX, is there anything else about this PR that I should change or revert?

ashwin-pc

@SergeyMyssak This change is much appreciated!

@BSFishy Im okay with either the # or oui.opensearch.org path as long as we are consistent. I think i agree with Kroosh here to make it easier for non technical users to know what this value can hold but im not picky about it. Its a two way door decision anyways.

Co-authored-by: Andrey Myssak <[email protected]> Signed-off-by: Sergey Myssak <[email protected]>

opensearch-trigger-bot · 2023-06-28T17:28:27Z

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-1.x 1.x
# Navigate to the new working tree
pushd ../.worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-720-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 fabf555ea2c7204699c5a639e35b522681bc0811
# Push it to GitHub
git push --set-upstream origin backport/backport-720-to-1.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-720-to-1.x.

…oject#720) Signed-off-by: Sergey Myssak <[email protected]> Co-authored-by: Andrey Myssak <[email protected]>

* Remove beta badge accent color (#99) Signed-off-by: Matt Provost <[email protected]> Signed-off-by: Matt Provost <[email protected]> * OUI combo box refine (#183) * Added a prop clearOnBlur Signed-off-by: AbhishekReddy1127 <[email protected]> * Added example for prop clearOnBlur Signed-off-by: AbhishekReddy1127 <[email protected]> --------- Signed-off-by: AbhishekReddy1127 <[email protected]> * Update Comment List Docs (#252) Signed-off-by: Matt Provost <[email protected]> * Updated the section Collapsable Nav (#330) Signed-off-by: AbhishekReddy1127 <[email protected]> Co-authored-by: Sean Neumann <[email protected]> * Updated the kibana to opensearch_dashboards (#343) Signed-off-by: AbhishekReddy1127 <[email protected]> * Updated the section drag and drop (#514) Signed-off-by: AbhishekReddy1127 <[email protected]> Co-authored-by: Sean Neumann <[email protected]> * Update @svgr/core and @svgr/plugin-svgo (#594) (#649) Signed-off-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> * Migrate from faker to @faker-js/faker (#594) (#655) Signed-off-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> * Bump @faker-js/faker to v8 (#594) (#768) Signed-off-by: Andrey Myssak <[email protected]> * change beta to experimental (#383) Signed-off-by: Ashwin P Chandran <[email protected]> Co-authored-by: Sean Neumann <[email protected]> * Normalize interlink URL usage (#698) (#720) Signed-off-by: Sergey Myssak <[email protected]> Co-authored-by: Andrey Myssak <[email protected]> * [CCI] Add `useDeprecatedPropWarning` and align with `deprecated` hoc (#762) * Add useDeprecatedPropWarning and align with deprecated hoc (#761) Co-authored-by: Andrey Myssak <[email protected]> Signed-off-by: Sergey Myssak <[email protected]> * Add multiple props to useDeprecatedPropWarning and pass getMessage to deprecatedComponentWarning (#761) Co-authored-by: Andrey Myssak <[email protected]> Signed-off-by: Sergey Myssak <[email protected]> * Use ExclusiveUnion in interfaces (#761) Co-authored-by: Andrey Myssak <[email protected]> Signed-off-by: Sergey Myssak <[email protected]> --------- Signed-off-by: Sergey Myssak <[email protected]> Co-authored-by: Andrey Myssak <[email protected]> * Update the default branch (#584) (#798) Signed-off-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> * [OuiComboBox] Add docs for icon and revise example for clearOnBlur (#806) Signed-off-by: Miki <[email protected]> * Updated bug issue template (#764) * Update bug issue template Signed-off-by: Sirazh Gabdullin <[email protected]> * Add spacing Signed-off-by: Sirazh Gabdullin <[email protected]> --------- Signed-off-by: Sirazh Gabdullin <[email protected]> * Move OuiBottomBar default inline styles to the CSS file (#693) (#694) Signed-off-by: Sergey Myssak <[email protected]> Co-authored-by: Andrey Myssak <[email protected]> * [CCI] Update react-window and react-virtualized-auto-sizer dependencies (#652) * Update react-window (#594) * Update react-virtualized-auto-sizer (#594) Co-authored-by: Sergey Myssak <[email protected]> Signed-off-by: Andrey Myssak <[email protected]> --------- Signed-off-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> * Update dropzone (#594) (#651) Signed-off-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> * Updated the section Beta badge (#338) Signed-off-by: AbhishekReddy1127 <[email protected]> * Add props and examples for the combobox (#660) Signed-off-by: AbhishekReddy1127 <[email protected]> * Updated the links in the section Markdown Format (#365) Signed-off-by: AbhishekReddy1127 <[email protected]> * Update Notification event page (#549) Signed-off-by: manasvinibs <[email protected]> Co-authored-by: Sean Neumann <[email protected]> * Updated the content in the section Messages and loading (#350) Signed-off-by: AbhishekReddy1127 <[email protected]> * Updated the content in the section suggest (#347) Signed-off-by: AbhishekReddy1127 <[email protected]> * Update affiliation of Andrey and Sergey (#794) Signed-off-by: Matt Provost <[email protected]> * [CCI] Update dependencies (#716) * Update dependencies (#594) Co-authored-by: Sergey Myssak <[email protected]> Signed-off-by: Andrey Myssak <[email protected]> * Bump @axe-core/puppeteer to v4.6.1 and puppeteer to v19.11.1 Signed-off-by: Andrey Myssak <[email protected]> * Bump react-window, tabbable and rimraf patch versions Signed-off-by: Andrey Myssak <[email protected]> * Bump @svgr/core, @svgr/plugin-svgo and @svgr/plugin-jsx to v8 Signed-off-by: Andrey Myssak <[email protected]> --------- Signed-off-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> * Replace @elastic/datemath with @opensearch/datemath (#204) * Replace @elastic/datemath with @opensearch/datemath Signed-off-by: Matt Provost <[email protected]> * Clean up Signed-off-by: Matt Provost <[email protected]> --------- Signed-off-by: Matt Provost <[email protected]> * Bump semver to 7.5.3 (#855) * Bump semver to 7.5.3 Signed-off-by: Matt Provost <[email protected]> * Add resolution to eslint plugin Signed-off-by: Matt Provost <[email protected]> --------- Signed-off-by: Matt Provost <[email protected]> * Remove Split button from OUI docs (#805) (#812) Signed-off-by: Sergey Myssak <[email protected]> Co-authored-by: Andrey Myssak <[email protected]> * Updated the text in the section ErrorBoundary (#366) Signed-off-by: AbhishekReddy1127 <[email protected]> * Docs site changes (#96) * first change Signed-off-by: Kroosh Crusius <[email protected]> * undoing first change Signed-off-by: Kroosh Crusius <[email protected]> * making a sample change to test commit success or failure Signed-off-by: Kroosh Crusius <[email protected]> * undoes sample change for testing Signed-off-by: Kroosh Crusius <[email protected]> * minor changes for tone, deleted references to starter projects as they are not maintained by OSD Signed-off-by: Kroosh Crusius <[email protected]> * Delete OUI.iml Removing as included accidentally. * Delete oui.iml Removing as included accidentally. * Update getting_started.md Updated link to node version manager to avoid redirect --------- Signed-off-by: Kroosh Crusius <[email protected]> * Update getting_started.md to remove elastic reference and other changes (#502) Signed-off-by: manasvinibs <[email protected]> * Removed GitHub column from all the tables (#371) Signed-off-by: AbhishekReddy1127 <[email protected]> * Updated the content and Icons in the section CssUtilityClasses (#368) Signed-off-by: AbhishekReddy1127 <[email protected]> * Delete Kibana reference in commands (#535) * Delete kibana reference in commands Signed-off-by: abbyhu2000 <[email protected]> * Change the tgz naming to opensearch Signed-off-by: abbyhu2000 <[email protected]> * Updated doc site link and github reference Signed-off-by: abbyhu2000 <[email protected]> * Change URL to only include domain Signed-off-by: abbyhu2000 <[email protected]> --------- Signed-off-by: abbyhu2000 <[email protected]> Co-authored-by: Sean Neumann <[email protected]> * fixed invalid link in FAQ.md (#751) Signed-off-by: Aigerim Suleimenova <[email protected]> --------- Signed-off-by: Matt Provost <[email protected]> Signed-off-by: AbhishekReddy1127 <[email protected]> Signed-off-by: Andrey Myssak <[email protected]> Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: Sergey Myssak <[email protected]> Signed-off-by: Miki <[email protected]> Signed-off-by: Sirazh Gabdullin <[email protected]> Signed-off-by: manasvinibs <[email protected]> Signed-off-by: Kroosh Crusius <[email protected]> Signed-off-by: abbyhu2000 <[email protected]> Signed-off-by: Aigerim Suleimenova <[email protected]> Co-authored-by: Matt Provost <[email protected]> Co-authored-by: Abhishek Reddy <[email protected]> Co-authored-by: Sean Neumann <[email protected]> Co-authored-by: Andrey Myssak <[email protected]> Co-authored-by: Sergey Myssak <[email protected]> Co-authored-by: Ashwin P Chandran <[email protected]> Co-authored-by: Andrey Myssak <[email protected]> Co-authored-by: Sirazh Gabdullin <[email protected]> Co-authored-by: Manasvini B Suryanarayana <[email protected]> Co-authored-by: Kroosh <[email protected]> Co-authored-by: Qingyang(Abby) Hu <[email protected]> Co-authored-by: Aigerim Suleimenova <[email protected]>

SergeyMyssak requested review from seanneumann, AMoo-Miki, rednaksi91, KrooshalUX, BSFishy and bandinib-amzn as code owners April 18, 2023 01:53

SergeyMyssak commented Apr 18, 2023

View reviewed changes

SergeyMyssak force-pushed the 698-Normalize-interlink-URL-usage branch from 9e54be0 to 333f65f Compare April 18, 2023 03:52

SergeyMyssak commented Apr 18, 2023

View reviewed changes

joshuarrrr added the CCI College Contributor Initiative label Apr 18, 2023

SergeyMyssak force-pushed the 698-Normalize-interlink-URL-usage branch from 333f65f to 2b7c619 Compare April 19, 2023 04:02

BSFishy reviewed Apr 25, 2023

View reviewed changes

ashwin-pc approved these changes May 16, 2023

View reviewed changes

SergeyMyssak force-pushed the 698-Normalize-interlink-URL-usage branch from 2b7c619 to 3eae5c1 Compare June 14, 2023 08:59

SergeyMyssak requested a review from joshuarrrr as a code owner June 14, 2023 08:59

SergeyMyssak force-pushed the 698-Normalize-interlink-URL-usage branch from 3eae5c1 to c0fa659 Compare June 15, 2023 08:33

SergeyMyssak linked an issue Jun 16, 2023 that may be closed by this pull request

(OUI Docs) Normalize interlink URL useage #698

Closed

SergeyMyssak removed a link to an issue Jun 16, 2023

(OUI Docs) Normalize interlink URL useage #698

Closed

SergeyMyssak linked an issue Jun 16, 2023 that may be closed by this pull request

(OUI Docs) Normalize interlink URL useage #698

Closed

Normalize interlink URL usage (opensearch-project#698)

5896c2c

Co-authored-by: Andrey Myssak <[email protected]> Signed-off-by: Sergey Myssak <[email protected]>

SergeyMyssak force-pushed the 698-Normalize-interlink-URL-usage branch from c0fa659 to 5896c2c Compare June 20, 2023 03:41

SergeyMyssak requested a review from andreymyssak as a code owner June 20, 2023 03:41

manasvinibs approved these changes Jun 27, 2023

View reviewed changes

BSFishy approved these changes Jun 28, 2023

View reviewed changes

joshuarrrr added the backport 1.x label Jun 28, 2023

joshuarrrr merged commit fabf555 into opensearch-project:main Jun 28, 2023

AMoo-Miki pushed a commit to AMoo-Miki/oui that referenced this pull request Jul 2, 2023

Normalize interlink URL usage (opensearch-project#698) (opensearch-pr…

adccbf1

…oject#720) Signed-off-by: Sergey Myssak <[email protected]> Co-authored-by: Andrey Myssak <[email protected]>

AMoo-Miki mentioned this pull request Jul 2, 2023

[Manual][backport 1.x] Several changes #872

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CCI] Normalize interlink URL usage #720

[CCI] Normalize interlink URL usage #720

SergeyMyssak commented Apr 18, 2023

SergeyMyssak commented Apr 18, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

KrooshalUX Apr 18, 2023

SergeyMyssak Apr 19, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

KrooshalUX Apr 18, 2023

SergeyMyssak Apr 19, 2023

SergeyMyssak Apr 18, 2023

KrooshalUX Apr 18, 2023

SergeyMyssak Apr 19, 2023

SergeyMyssak Apr 18, 2023

KrooshalUX Apr 18, 2023 •

edited

Loading

SergeyMyssak Apr 19, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

SergeyMyssak Apr 18, 2023

KrooshalUX commented Apr 18, 2023

BSFishy left a comment

KrooshalUX commented Apr 27, 2023

SergeyMyssak commented May 3, 2023

ashwin-pc left a comment

opensearch-trigger-bot bot commented Jun 28, 2023

[CCI] Normalize interlink URL usage #720

[CCI] Normalize interlink URL usage #720

Conversation

SergeyMyssak commented Apr 18, 2023

Description

Issues Resolved

Check List

SergeyMyssak commented Apr 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KrooshalUX Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KrooshalUX commented Apr 18, 2023

BSFishy left a comment

Choose a reason for hiding this comment

KrooshalUX commented Apr 27, 2023

SergeyMyssak commented May 3, 2023

ashwin-pc left a comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Jun 28, 2023

KrooshalUX Apr 18, 2023 •

edited

Loading