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

Update doc links to point to OpenSearch #30

Merged
merged 2 commits into from
May 20, 2021

Conversation

ohltyler
Copy link
Member

Signed-off-by: Tyler Ohlsen ohltyler@amazon.com

Description

Updates the documentation links to point to the new home for docs: https://docs-beta.opensearch.org/

Refactored the base doc link into a constant to make it easier to change in the future (e.g., going from docs-beta.opensearch -> docs.opensearch).

Sanity tested on the UI to make sure they work.

Issues Resolved

Resolves #27

Check List

  • 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: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler added the documentation Improvements or additions to documentation label May 20, 2021
@ohltyler ohltyler requested review from kaituo, ylwu-amzn and spbjss May 20, 2021 00:21
@ylwu-amzn
Copy link
Contributor

@ohltyler
Copy link
Member Author

Searched "opendistro.github" in the branch doc-links and found this one https://github.com/ohltyler/anomaly-detection-dashboards-plugin-1/blob/doc-links/public/pages/DetectorConfig/containers/__tests__/__snapshots__/DetectorConfig.test.tsx.snap#L396

Good catch. yarn test:jest -u didn't update this snapshot since it is related to a skipped test. Manually deleted the snapshot.

Copy link
Contributor

@ylwu-amzn ylwu-amzn left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the change!

@@ -1,7 +1,7 @@
[![Unit tests](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/workflows/Unit%20tests%20workflow/badge.svg)](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/actions?query=workflow%3A%22Unit+tests+workflow%22)
[![Integration tests](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/workflows/E2E%20tests%20workflow/badge.svg)](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/actions?query=workflow%3A%22E2E+tests+workflow%22)
[![codecov](https://codecov.io/gh/opensearch-project/anomaly-detection-dashboards-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/anomaly-detection-dashboards-plugin)
[![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://opendistro.github.io/for-elasticsearch-docs/docs/ad/)
[![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://docs-beta.opensearch.org/docs/ad/)
Copy link

Choose a reason for hiding this comment

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

Would we change the "beta" to "release" or something else later?

Copy link
Member Author

Choose a reason for hiding this comment

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

Most likely. That's why I refactored it into a constant (see second line of PR description).

Copy link

@spbjss spbjss left a comment

Choose a reason for hiding this comment

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

looks good to me.

@ohltyler ohltyler merged commit 1e5ec54 into opensearch-project:main May 20, 2021
@ohltyler ohltyler deleted the doc-links branch May 20, 2021 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update links to documentation
3 participants