-
Notifications
You must be signed in to change notification settings - Fork 73
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
[CCI] Normalize interlink URL usage #720
[CCI] Normalize interlink URL usage #720
Conversation
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? |
const badgeHrefSnippet = [ | ||
'<OuiBadge href="https://oui.opensearch.org/latest/" />', | ||
]; |
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.
<OuiLink href="https://oui.opensearch.org/latest/"> | ||
this link can help | ||
</OuiLink> | ||
. |
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.
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.
The links in the call outs should go to https://opensearch.org/docs/latest/
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.
@@ -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>. |
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.
<OuiLink href="https://oui.opensearch.org/latest/"> | ||
here’s a link | ||
</OuiLink> | ||
. |
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.
<OuiLink href="https://oui.opensearch.org/latest/"> | ||
here’s a link | ||
</OuiLink> | ||
. |
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.
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.
Lets use https://opensearch.org/docs/latest/ for this demo.
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.
@@ -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> |
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.
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.
These should not be links, the # is on purpose to show a tooltip only.
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.
9e54be0
to
333f65f
Compare
<OuiLink href="https://oui.opensearch.org/latest/"> | ||
Skip navigation | ||
</OuiLink> |
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.
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.
This skip navigation link is a demonstration of an accessibility tool, and should not have the URL associated with it.
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.
<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/" |
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.
<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> |
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.
<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/"> |
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.
@@ -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/" |
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.
href="https://oui.opensearch.org/latest/" | ||
label="Ghost" | ||
color="ghost" | ||
/> |
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.
@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. |
333f65f
to
2b7c619
Compare
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.
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
@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? |
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.
@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.
2b7c619
to
3eae5c1
Compare
3eae5c1
to
c0fa659
Compare
Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com>
c0fa659
to
5896c2c
Compare
The backport to
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 |
…oject#720) Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> Co-authored-by: Andrey Myssak <andreymyssak@gmail.com>
* Remove beta badge accent color (#99) Signed-off-by: Matt Provost <provomat@amazon.com> Signed-off-by: Matt Provost <provomat@amazon.com> * OUI combo box refine (#183) * Added a prop clearOnBlur Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Added example for prop clearOnBlur Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> --------- Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Update Comment List Docs (#252) Signed-off-by: Matt Provost <provomat@amazon.com> * Updated the section Collapsable Nav (#330) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> Co-authored-by: Sean Neumann <1413295+seanneumann@users.noreply.github.com> * Updated the kibana to opensearch_dashboards (#343) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Updated the section drag and drop (#514) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> Co-authored-by: Sean Neumann <1413295+seanneumann@users.noreply.github.com> * Update @svgr/core and @svgr/plugin-svgo (#594) (#649) Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> * Migrate from faker to @faker-js/faker (#594) (#655) Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> * Bump @faker-js/faker to v8 (#594) (#768) Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> * change beta to experimental (#383) Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Co-authored-by: Sean Neumann <1413295+seanneumann@users.noreply.github.com> * Normalize interlink URL usage (#698) (#720) Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> * [CCI] Add `useDeprecatedPropWarning` and align with `deprecated` hoc (#762) * Add useDeprecatedPropWarning and align with deprecated hoc (#761) Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> * Add multiple props to useDeprecatedPropWarning and pass getMessage to deprecatedComponentWarning (#761) Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> * Use ExclusiveUnion in interfaces (#761) Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> --------- Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> * Update the default branch (#584) (#798) Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> * [OuiComboBox] Add docs for icon and revise example for clearOnBlur (#806) Signed-off-by: Miki <miki@amazon.com> * Updated bug issue template (#764) * Update bug issue template Signed-off-by: Sirazh Gabdullin <sirazh.gabdullin@nu.edu.kz> * Add spacing Signed-off-by: Sirazh Gabdullin <sirazh.gabdullin@nu.edu.kz> --------- Signed-off-by: Sirazh Gabdullin <sirazh.gabdullin@nu.edu.kz> * Move OuiBottomBar default inline styles to the CSS file (#693) (#694) Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> * [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 <sergey.myssak@gmail.com> Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> --------- Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> * Update dropzone (#594) (#651) Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> * Updated the section Beta badge (#338) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Add props and examples for the combobox (#660) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Updated the links in the section Markdown Format (#365) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Update Notification event page (#549) Signed-off-by: manasvinibs <manasvis@amazon.com> Co-authored-by: Sean Neumann <1413295+seanneumann@users.noreply.github.com> * Updated the content in the section Messages and loading (#350) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Updated the content in the section suggest (#347) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Update affiliation of Andrey and Sergey (#794) Signed-off-by: Matt Provost <provomat@amazon.com> * [CCI] Update dependencies (#716) * Update dependencies (#594) Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> * Bump @axe-core/puppeteer to v4.6.1 and puppeteer to v19.11.1 Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> * Bump react-window, tabbable and rimraf patch versions Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> * Bump @svgr/core, @svgr/plugin-svgo and @svgr/plugin-jsx to v8 Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> --------- Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> * Replace @elastic/datemath with @opensearch/datemath (#204) * Replace @elastic/datemath with @opensearch/datemath Signed-off-by: Matt Provost <provomat@amazon.com> * Clean up Signed-off-by: Matt Provost <provomat@amazon.com> --------- Signed-off-by: Matt Provost <provomat@amazon.com> * Bump semver to 7.5.3 (#855) * Bump semver to 7.5.3 Signed-off-by: Matt Provost <provomat@amazon.com> * Add resolution to eslint plugin Signed-off-by: Matt Provost <provomat@amazon.com> --------- Signed-off-by: Matt Provost <provomat@amazon.com> * Remove Split button from OUI docs (#805) (#812) Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> * Updated the text in the section ErrorBoundary (#366) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Docs site changes (#96) * first change Signed-off-by: Kroosh Crusius <kroosh@amazon.com> * undoing first change Signed-off-by: Kroosh Crusius <kroosh@amazon.com> * making a sample change to test commit success or failure Signed-off-by: Kroosh Crusius <kroosh@amazon.com> * undoes sample change for testing Signed-off-by: Kroosh Crusius <kroosh@amazon.com> * minor changes for tone, deleted references to starter projects as they are not maintained by OSD Signed-off-by: Kroosh Crusius <kroosh@amazon.com> * 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 <kroosh@amazon.com> * Update getting_started.md to remove elastic reference and other changes (#502) Signed-off-by: manasvinibs <manasvis@amazon.com> * Removed GitHub column from all the tables (#371) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Updated the content and Icons in the section CssUtilityClasses (#368) Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> * Delete Kibana reference in commands (#535) * Delete kibana reference in commands Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Change the tgz naming to opensearch Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Updated doc site link and github reference Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Change URL to only include domain Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> Co-authored-by: Sean Neumann <1413295+seanneumann@users.noreply.github.com> * fixed invalid link in FAQ.md (#751) Signed-off-by: Aigerim Suleimenova <aigerim.suleimenova27@gmail.com> --------- Signed-off-by: Matt Provost <provomat@amazon.com> Signed-off-by: AbhishekReddy1127 <nallamsa@amazon.com> Signed-off-by: Andrey Myssak <andreymyssak@gmail.com> Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Signed-off-by: Sergey Myssak <sergey.myssak@gmail.com> Signed-off-by: Miki <miki@amazon.com> Signed-off-by: Sirazh Gabdullin <sirazh.gabdullin@nu.edu.kz> Signed-off-by: manasvinibs <manasvis@amazon.com> Signed-off-by: Kroosh Crusius <kroosh@amazon.com> Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> Signed-off-by: Aigerim Suleimenova <aigerim.suleimenova27@gmail.com> Co-authored-by: Matt Provost <provomat@amazon.com> Co-authored-by: Abhishek Reddy <62020972+AbhishekReddy1127@users.noreply.github.com> Co-authored-by: Sean Neumann <1413295+seanneumann@users.noreply.github.com> Co-authored-by: Andrey Myssak <40265277+andreymyssak@users.noreply.github.com> Co-authored-by: Sergey Myssak <sergey.myssak@gmail.com> Co-authored-by: Ashwin P Chandran <ashwinpc1993@gmail.com> Co-authored-by: Andrey Myssak <andreymyssak@gmail.com> Co-authored-by: Sirazh Gabdullin <sirazh.gabdullin@nu.edu.kz> Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com> Co-authored-by: Kroosh <kroosh@amazon.com> Co-authored-by: Qingyang(Abby) Hu <abigailhu2000@gmail.com> Co-authored-by: Aigerim Suleimenova <aigerim.suleimenova27@gmail.com>
Description
Normalized interlink URL usage
Issues Resolved
#698
Check List
yarn lint
yarn test-unit
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.