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

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

Closed
joshuarrrr opened this issue Mar 28, 2023 · 3 comments · Fixed by #3724
Closed

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

joshuarrrr opened this issue Mar 28, 2023 · 3 comments · Fixed by #3724
Assignees
Labels
console docs Improvements or additions to documentation good first issue Good for newcomers

Comments

@joshuarrrr
Copy link
Member

joshuarrrr commented Mar 28, 2023

In the Dev Tools console, one the actions available when clicking the wrench icon next to a query is to "Open documentation". This is a very helpful contextual dual to directly link API endpoints discoverable via autocomplete to their user docs. The problem is that many of these links are broken.

Screen.Recording.2023-03-27.at.6.01.39.PM.mov

For example:

"documentation": "https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/put-pipeline-api.html"

Should point to https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/

The task is to audit the documentation values in the JSON files in https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console/server/lib/spec_definitions/json/generated

and either

  1. Update the link if a corresponding documentation page exists on https://opensearch.org
  2. OR Open a single issue on https://github.com/opensearch-project/documentation-website that lists all the missing docs. In these cases update the link to just https://opensearch.org/docs/

Additionally, links in comments should be fixed or updated in https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console/server/lib/spec_definitions/js/ingest.ts

Exit criteria:

There should be no more strings matching/guide/en/elasticsearch in the https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console plugin directory.

@joshuarrrr joshuarrrr added docs Improvements or additions to documentation good first issue Good for newcomers console labels Mar 28, 2023
@curq
Copy link
Collaborator

curq commented Mar 28, 2023

Hi @joshuarrrr, can I take this issue?

@kavilla kavilla removed the untriaged label Mar 28, 2023
@kavilla
Copy link
Member

kavilla commented Mar 28, 2023

@curq I don't see why not! Go for it!

@joshuarrrr
Copy link
Member Author

@curq See also #3685, which may help identify some of the missing links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
console docs Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants