[Docs] [Console] Fixed/updated documentation links in Dev Tools console

[curq]

Description

1. After auditing JSON files in https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console/server/lib/spec_definitions/json/generated I updated every old link to the relevant link to documentation. They were outdated, so every link was updated. Now in dev console they open correct links instead of outdated ones that redirect to the main page.
2. Every api endpoint that wasn't documented in docs was listed in the new issue as pre request [DOC-META] Missing api documentation documentation-website#3614 Also, links were updated to https://opensearch.org/docs/
3. The https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console/server/lib/spec_definitions/js/ingest.ts was also audited and links were updated.
4. Many processors were not documented, so their links were changed to the https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/ and reported missed documentation in [DOC-META] Missing api documentation documentation-website#3614
5. As per exit criteria no strings matching /guide/en/elasticsearch were left in the plugin directory.

Important notes:

• info.json and ping.json had link that pointed to https://opensearch.org/docs/latest/opensearch/index/, which I assumed was base url so they were changed to https://opensearch.org/docs/
• in get_script_languages.json and get_script_context.json there was no documentation attribute so the Open Documentation button in Dev Tools console was not working, so I added it with appropriate link and now it opens correct documentation page.
• cluster.delete_component_template.json, cluster.exists_component_template.json, cluster.get_component_template.json were not documented but instead of main docs page I linked them to https://opensearch.org/docs/latest/im-plugin/index-templates/, because PUT method of the same pattern was documented there so I assumed that after docs will be updated this will be the correct link.
• same situation with reindex_rethrottle.json, delete_by_query_rethrottle.json and update_by_query_rethrottle.json. I linked them to the same links as reindex.json, delete_by_query.json and update_by_query.json. It is the same pattern as with the outdated links, because I presume that rethrottle variation of pattern should be described on the same page. At least I found similar pattern in elasticsearch documentation of the same features. (e.g. https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html)

Issues Resolved

Fixes #3714

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
  • yarn test:ftr
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[AMoo-Miki]

Thanks Sirazh for this.

[joshuarrrr]

@curq This is awesome - I'm excited to get it in the next release! I'm reviewing today and should have some feedback shortly.

[codecov-commenter]

Codecov Report

Merging #3724 (d95970f) into main (2db2c43) will decrease coverage by 0.07%.
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    #3724      +/-   ##
==========================================
- Coverage   66.43%   66.37%   -0.07%     
==========================================
  Files        3210     3210              
  Lines       61677    61677              
  Branches     9522     9522              
==========================================
- Hits        40977    40939      -38     
- Misses      18419    18450      +31     
- Partials     2281     2288       +7     

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

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

Impacted Files	Coverage Δ
...s/console/server/lib/spec_definitions/js/ingest.ts	92.50% <ø> (ø)

... and 8 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]

@curq Thanks, this is excellent - great job finding the most relevant doc available. I was able to find just a couple more, and in some cases, even where we don't have docs available, I think we can at least get the user closer, so I made some suggestions along those lines.

[joshuarrrr]

out of scope for this PR, but this has been deprecated, updated to https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ - I'll make a separate issue to update.

[joshuarrrr]

Failing cypress test workflow can be ignored

[curq]

Thank you for your review @joshuarrrr
I answered to some of your comments, can you please look through them? Then I will update the links according to the proposed changes.

[seanneumann]

This is amazing! Thanks @curq!!

[curq]

I added some more changes after reviewing the feedback here is short summary of changes:

• Updated cluster.* missing links to https://opensearch.org/docs/latest/api-reference/cluster-api/index/
• Updated indices.* missing links to https://opensearch.org/docs/latest/api-reference/cluster-api/index/ I also updated other similar indices.* files that were not mentioned in feedback as I noticed them after rechecking the json files.
• Updated links with anchor tags to make user jump to the relevant section of the page immediately.
• Updated links in .json files that were suggested by feedback like cat.master.json or ingest.processor_grok.json
• Fixed CHANGELOG.md formatting by adding the space as was suggested.

In the suggestions above I commented some of my reasoning behind the changes.

[joshuarrrr]

@curq Thanks for all the updates and explanations. I'm running all the automated workflows now, but expect to be able to approve soon.

[opensearch-trigger-bot]

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 128

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-3724-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 01a0baf4a62725ee6e53f5f3c65fb4c4eb0e09c0
# Push it to GitHub
git push --set-upstream origin backport/backport-3724-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 base branch is 1.x and the compare/head branch is backport/backport-3724-to-1.x.

[opensearch-trigger-bot]

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 1

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.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-3724-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 01a0baf4a62725ee6e53f5f3c65fb4c4eb0e09c0
# Push it to GitHub
git push --set-upstream origin backport/backport-3724-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-3724-to-1.3.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

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-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-3724-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 01a0baf4a62725ee6e53f5f3c65fb4c4eb0e09c0
# Push it to GitHub
git push --set-upstream origin backport/backport-3724-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-3724-to-2.x.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

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-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-3724-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 01a0baf4a62725ee6e53f5f3c65fb4c4eb0e09c0
# Push it to GitHub
git push --set-upstream origin backport/backport-3724-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-3724-to-2.x.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

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-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-3724-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 01a0baf4a62725ee6e53f5f3c65fb4c4eb0e09c0
# Push it to GitHub
git push --set-upstream origin backport/backport-3724-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-3724-to-2.x.

[joshuarrrr]

backporting wasn't completed in time for 1.3.10 - relabeling for 1.3.11.