[Doc Links Service] Clean up noDocumentation links #3685

sayuree · 2023-03-24T11:05:23Z

Description

[Added corresponding links from the documentation for non-working links
Edited DocLinksStart interface properties
Edited the usage of interface in other files correspondigly
]

Issues Resolved

fixes #3208

Check List

Abyl10 · 2023-03-27T03:19:00Z

Thank you for your recent code changes! I noticed that the CHANGELOG.md file was not updated to reflect the recent changes. It's important that we keep the changelog up-to-date so that other developers can understand what changes were made, why they were made, and how they may impact the codebase. Could you please update the CHANGELOG.md file with as much detail as possible?

codecov-commenter · 2023-03-27T19:23:37Z

Codecov Report

Merging #3685 (efad27d) into main (925b96d) will decrease coverage by 0.01%.
The diff coverage is n/a.

📣 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    #3685      +/-   ##
==========================================
- Coverage   66.43%   66.43%   -0.01%     
==========================================
  Files        3210     3210              
  Lines       61677    61677              
  Branches     9522     9522              
==========================================
- Hits        40977    40973       -4     
- Misses      18419    18422       +3     
- Partials     2281     2282       +1

Flag	Coverage Δ
Linux	`66.37% <ø> (-0.01%)`	⬇️
Windows	`66.38% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/core/public/doc_links/doc_links_service.ts	`100.00% <ø> (ø)`
...lugins/visualize/public/application/utils/utils.ts	`26.66% <ø> (ø)`

... and 2 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.

joshuarrrr

@sayuree Thanks for the PR - it mostly looks great!

I found some additional links that can be defined.

There are also some minor requested changes.

CHANGELOG.md

src/core/public/doc_links/doc_links_service.ts

CHANGELOG.md

joshuarrrr

@sayuree Can you also add the commented links to the restAPI section (L330-340)?

joshuarrrr

For L442-L445, please move visualize to the opensearchDashboards section and update visualize.guide to be https://opensearch.org/docs/latest/dashboards/visualize/viz-index/

joshuarrrr · 2023-03-29T17:08:48Z

...ce_management/public/management_app/compoenent/experimental_callout/experimental_callout.tsx

@@ -40,7 +40,7 @@ export const ExperimentalCallout = ({ docLinks }: { docLinks: DocLinksStart }) =
 defaultMessage="To leave feedback, visit "
 />
 }
- <EuiLink href={docLinks.links.noDocumentation.openSearchForum} target="_blank">
+ <EuiLink href={docLinks.links.opensearch.openSearchForum} target="_blank">


Please also update the mock in src/plugins/data_source_management/public/mocks.ts

src/core/public/doc_links/doc_links_service.ts

joshuarrrr · 2023-04-04T01:49:12Z

@sayuree Will you be able to make the additional requested changes?

sayuree · 2023-04-04T17:27:08Z

@joshuarrrr Added requested changes

joshuarrrr

Thanks @sayuree , almost there! Just three tasks left, summarized here:

Can you also add the commented links to the restAPI section (L345-355)?
Please also update the mock in src/plugins/data_source_management/public/mocks.ts
See suggested changes for visualize.guide link.

joshuarrrr · 2023-04-04T17:54:27Z

src/core/public/doc_links/doc_links_service.ts

+ guide: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}discover/multi-data-sources/`,
+ },
+ visualize: {
+ guide: `${OPENSEARCH_WEBSITE_DOCS}`,


Suggested change

guide: `${OPENSEARCH_WEBSITE_DOCS}`,

// https://opensearch.org/docs/latest/dashboards/visualize/viz-index/

guide: `${OPENSEARCH_WEBSITE_DOCS}visualize/viz-index/`,

joshuarrrr

OK, looks good, I'll just wait for the automation to complete before approving. Thanks for all the changes!

src/plugins/data_source_management/public/mocks.ts

joshuarrrr · 2023-04-11T15:40:51Z

@sayuree Can you rebase or update the PR to resolve the conflict? I believe the experimental callout has since been removed.

Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz>

sayuree · 2023-04-11T19:12:45Z

@sayuree Can you rebase or update the PR to resolve the conflict? I believe the experimental callout has since been removed.

I have updated the PR, hope changes will be approved.

Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz> (cherry picked from commit 4e14aae) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ct#3685) Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz>

) * Add noDocumentation links (#3208) (#3685) Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz> (cherry picked from commit 4e14aae) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * update changelog Signed-off-by: Josh Romero <rmerqg@amazon.com> --------- Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Josh Romero <rmerqg@amazon.com>

…ct#3685) Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz> Signed-off-by: David Sinclair <david@sinclair.tech>

sayuree requested a review from a team as a code owner March 24, 2023 11:05

joshuarrrr added the OSCI Open Source Contributor Initiative label Mar 27, 2023

joshuarrrr self-assigned this Mar 27, 2023

joshuarrrr mentioned this pull request Mar 27, 2023

[Multiple Datasource] Help menu should include link to the documentation guide #3707

Open

joshuarrrr requested changes Mar 27, 2023

View reviewed changes

joshuarrrr mentioned this pull request Mar 28, 2023

[Docs] [Console] Fix/update documentation links in Dev Tools console #3714

Closed

joshuarrrr reviewed Mar 29, 2023

View reviewed changes

joshuarrrr changed the title ~~Add edits to noDocumentation links~~ Clean up noDocumentation links Mar 29, 2023

joshuarrrr changed the title ~~Clean up noDocumentation links~~ [Doc Links Service] Clean up noDocumentation links Mar 29, 2023

joshuarrrr reviewed Mar 29, 2023

View reviewed changes

src/core/public/doc_links/doc_links_service.ts Outdated Show resolved Hide resolved

joshuarrrr reviewed Apr 4, 2023

View reviewed changes

sayuree requested a review from joshuarrrr April 5, 2023 13:32

joshuarrrr reviewed Apr 5, 2023

View reviewed changes

src/plugins/data_source_management/public/mocks.ts Outdated Show resolved Hide resolved

joshuarrrr added v2.7.0 backport 2.x labels Apr 5, 2023

Add noDocumentation links (opensearch-project#3208)

9a1bd74

Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz>

sayuree force-pushed the fix-3208 branch from efad27d to 9a1bd74 Compare April 11, 2023 19:11

joshuarrrr mentioned this pull request Apr 12, 2023

2.7.0 Platform Upgrades for Plugins (O11y, MDS, Geospatial,+) #3674

Closed

23 tasks

joshuarrrr approved these changes Apr 13, 2023

View reviewed changes

AMoo-Miki approved these changes Apr 13, 2023

View reviewed changes

joshuarrrr merged commit 4e14aae into opensearch-project:main Apr 13, 2023

opensearch-trigger-bot bot mentioned this pull request Apr 13, 2023

[Backport 2.x] [Doc Links Service] Clean up noDocumentation links #3844

Merged

aoguan1990 pushed a commit to aoguan1990/OpenSearch-Dashboards that referenced this pull request Apr 14, 2023

Add noDocumentation links (opensearch-project#3208) (opensearch-proje…

fb3f4fd

…ct#3685) Signed-off-by: sabina.zaripova <sabina.zaripova@nu.edu.kz>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc Links Service] Clean up noDocumentation links #3685

[Doc Links Service] Clean up noDocumentation links #3685

sayuree commented Mar 24, 2023 •

edited

Loading

Abyl10 commented Mar 27, 2023

codecov-commenter commented Mar 27, 2023 •

edited

Loading

joshuarrrr left a comment

joshuarrrr left a comment

joshuarrrr left a comment

joshuarrrr Mar 29, 2023

joshuarrrr commented Apr 4, 2023

sayuree commented Apr 4, 2023

joshuarrrr left a comment

joshuarrrr Apr 4, 2023

joshuarrrr left a comment

joshuarrrr commented Apr 11, 2023

sayuree commented Apr 11, 2023

	guide: `${OPENSEARCH_WEBSITE_DOCS}`,
	// https://opensearch.org/docs/latest/dashboards/visualize/viz-index/
	guide: `${OPENSEARCH_WEBSITE_DOCS}visualize/viz-index/`,

[Doc Links Service] Clean up noDocumentation links #3685

[Doc Links Service] Clean up noDocumentation links #3685

Conversation

sayuree commented Mar 24, 2023 • edited Loading

Description

Issues Resolved

Check List

Abyl10 commented Mar 27, 2023

codecov-commenter commented Mar 27, 2023 • edited Loading

Codecov Report

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr Mar 29, 2023

Choose a reason for hiding this comment

joshuarrrr commented Apr 4, 2023

sayuree commented Apr 4, 2023

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr Apr 4, 2023

Choose a reason for hiding this comment

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr commented Apr 11, 2023

sayuree commented Apr 11, 2023

sayuree commented Mar 24, 2023 •

edited

Loading

codecov-commenter commented Mar 27, 2023 •

edited

Loading