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

[DOC] Broken links to opensearch.org in plugin READMEs #921

Closed
9 of 15 tasks
AWSHurneyt opened this issue Aug 18, 2022 · 6 comments
Closed
9 of 15 tasks

[DOC] Broken links to opensearch.org in plugin READMEs #921

AWSHurneyt opened this issue Aug 18, 2022 · 6 comments
Assignees
Labels
Closed - Complete Issue: Work is done and associated PRs closed Quick fix Issues that can be completed fast
Milestone

Comments

@AWSHurneyt
Copy link
Contributor

AWSHurneyt commented Aug 18, 2022

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
Several of the plugins (e.g., anomaly detection, alerting, ISM, etc.) contain links to the opendistro website in the READMEs for their back and frontend repositories. These links redirect to opensearch.org, but not to a functioning forum page. The link in the Alerting README for example links to https://forum.opensearch.org/c/alerting/, which displays a Oops! That page doesn’t exist or is private error message.

Is it possible for the ODFE pages to redirect to more appropriate forum pages on the OpenSearch site, or would the plugins need to update their READMEs with new links?

This is a list of PRs for individual plugin repositories affected by this issue:

  • Alerting plugin #545
  • Anomaly Detection plugin #659
  • Asynchronous search plugin #178
  • Cross-cluster replication plugin #548
  • Dashboards reports plugin #455
  • Index Management plugin #499
  • k-NN plugin #540
  • ML Commons plugin #418
  • Observability plugin #999
  • Performance Analyzer plugin #266
  • SQL plugin #809
@Naarcha-AWS Naarcha-AWS added Quick fix Issues that can be completed fast 1 - Backlog Issue: The issue is unassigned or assigned but not started and removed untriaged labels Aug 22, 2022
@Naarcha-AWS Naarcha-AWS modified the milestones: v2.3, 2022-Q3 Aug 22, 2022
@cwillum cwillum added the 2 - In progress Issue/PR: The issue or PR is in progress. label Sep 7, 2022
@cwillum
Copy link
Contributor

cwillum commented Sep 8, 2022

Waiting for owners/contributors of the various repositories to finish reviewing and merging the PRs. Once all of the PRs listed above have been merged, I'll close this issue.

@cwillum
Copy link
Contributor

cwillum commented Sep 9, 2022

Commented in remaining un-merged PRs (checkmark in list above indicates PR has been merged). Asked for final review and merge on my behalf (I don't have permission in those repos).

@AWSHurneyt
Copy link
Contributor Author

I just wanted to quickly clarify that these broken links are also present in the README files of the frontend plugins (e.g., alerting dashboards) as well.

@cwillum
Copy link
Contributor

cwillum commented Sep 12, 2022

@AWSHurneyt That's a good point. I think at this stage, it might be best to follow the advice of @saratvemulapalli and add a new issue in opensearch-plugins: "if [an issue] impacts 2 or more plugins, you can open a PR with a suggestion in STANDARDS.md and we could campaign it."

@AWSHurneyt
Copy link
Contributor Author

@cwillum Agreed. I've created the above issues in the opensearch-plugins folder.

@Naarcha-AWS Naarcha-AWS removed the 1 - Backlog Issue: The issue is unassigned or assigned but not started label Sep 13, 2022
@Naarcha-AWS
Copy link
Collaborator

Closing this issue since every broken link in question has either been fixed through merge or has a PR associated with it.

@hdhalter hdhalter added Closed - Complete Issue: Work is done and associated PRs closed and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Complete Issue: Work is done and associated PRs closed Quick fix Issues that can be completed fast
Projects
None yet
Development

No branches or pull requests

4 participants