Skip to content

Commit

Permalink
[Manual Backport 2.x] [Docs] [Console] Fixed/updated documentation li…
Browse files Browse the repository at this point in the history
…nks in Dev Tools console (#3883) (#3893)

* [Docs] [Console] Fixed/updated documentation links in Dev Tools console (#3724)

* Update console documentation links to corresponding documentation pages
* Update console documentation links to https://opensearch.org/docs/ because corresponding pages are missing/not yet written in documentation
* Update console documentation links for component_template delete, get and exists
* Update console documentation links for info.json and ping.json to index page https://opensearch.org/docs/
* Fix: added missing documentation links to get_script_context and get_script_languages
* Update links to processors in comments to their working documentation pages
* Update links to processors with no corresponding pages in documentation to the general page about processors https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
* Update CHANGELOG.md
* Update cluster.* links with missing docs to https://opensearch.org/docs/latest/api-reference/cluster-api/index/
* Update indices.* links with missing docs to https://opensearch.org/docs/latest/api-reference/index-apis/index/
* Update links with anchor # if applicable
* Update links



---------




(cherry picked from commit 01a0baf)

* remove changelog additions



---------



(cherry picked from commit 46b76b3)

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sirazh Gabdullin <sirazh.gabdullin@nu.edu.kz>
  • Loading branch information
3 people authored Apr 20, 2023
1 parent 5e8c7cd commit 2d3dbfc
Show file tree
Hide file tree
Showing 153 changed files with 631 additions and 293 deletions.
66 changes: 33 additions & 33 deletions src/plugins/console/server/lib/spec_definitions/js/ingest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const commonPipelineParams = {
tag: '',
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/append-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const appendProcessorDefinition = {
append: {
__template: {
Expand All @@ -52,7 +52,7 @@ const appendProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/bytes-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const bytesProcessorDefinition = {
bytes: {
__template: {
Expand All @@ -67,7 +67,7 @@ const bytesProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/ingest-circle-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const circleProcessorDefinition = {
circle: {
__template: {
Expand All @@ -88,7 +88,7 @@ const circleProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/csv-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/csv/
const csvProcessorDefinition = {
csv: {
__template: {
Expand All @@ -110,7 +110,7 @@ const csvProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/convert-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const convertProcessorDefinition = {
convert: {
__template: {
Expand All @@ -129,7 +129,7 @@ const convertProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/date-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/date/
const dateProcessorDefinition = {
date: {
__template: {
Expand All @@ -145,7 +145,7 @@ const dateProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/date-index-name-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const dateIndexNameProcessorDefinition = {
date_index_name: {
__template: {
Expand All @@ -164,7 +164,7 @@ const dateIndexNameProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/dissect-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const dissectProcessorDefinition = {
dissect: {
__template: {
Expand All @@ -181,7 +181,7 @@ const dissectProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/dot-expand-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const dotExpanderProcessorDefinition = {
dot_expander: {
__template: {
Expand All @@ -193,15 +193,15 @@ const dotExpanderProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/drop-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const dropProcessorDefinition = {
drop: {
__template: {},
...commonPipelineParams,
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/fail-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const failProcessorDefinition = {
fail: {
__template: {
Expand All @@ -212,7 +212,7 @@ const failProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/foreach-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const foreachProcessorDefinition = {
foreach: {
__template: {
Expand All @@ -227,7 +227,7 @@ const foreachProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/geoip-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const geoipProcessorDefinition = {
geoip: {
__template: {
Expand All @@ -246,7 +246,7 @@ const geoipProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/grok-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/grok/
const grokProcessorDefinition = {
grok: {
__template: {
Expand All @@ -266,7 +266,7 @@ const grokProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/gsub-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const gsubProcessorDefinition = {
gsub: {
__template: {
Expand All @@ -281,7 +281,7 @@ const gsubProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/htmlstrip-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const htmlStripProcessorDefinition = {
html_strip: {
__template: {
Expand All @@ -296,7 +296,7 @@ const htmlStripProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/inference-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const inferenceProcessorDefinition = {
inference: {
__template: {
Expand All @@ -312,7 +312,7 @@ const inferenceProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/join-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const joinProcessorDefinition = {
join: {
__template: {
Expand All @@ -325,7 +325,7 @@ const joinProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/json-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/parse-json/
const jsonProcessorDefinition = {
json: {
__template: {
Expand All @@ -340,7 +340,7 @@ const jsonProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/kv-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const kvProcessorDefinition = {
kv: {
__template: {
Expand All @@ -360,7 +360,7 @@ const kvProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/lowercase-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/lowercase-string/
const lowercaseProcessorDefinition = {
lowercase: {
__template: {
Expand All @@ -374,7 +374,7 @@ const lowercaseProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/pipeline-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const pipelineProcessorDefinition = {
pipeline: {
__template: {
Expand All @@ -385,7 +385,7 @@ const pipelineProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/remove-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const removeProcessorDefinition = {
remove: {
__template: {
Expand All @@ -396,7 +396,7 @@ const removeProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/rename-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const renameProcessorDefinition = {
rename: {
__template: {
Expand All @@ -412,7 +412,7 @@ const renameProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/script-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const scriptProcessorDefinition = {
script: {
__template: {},
Expand All @@ -425,7 +425,7 @@ const scriptProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/set-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const setProcessorDefinition = {
set: {
__template: {
Expand All @@ -441,7 +441,7 @@ const setProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/ingest-node-set-security-user-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const setSecurityUserProcessorDefinition = {
set_security_user: {
__template: {
Expand All @@ -453,7 +453,7 @@ const setSecurityUserProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/split-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/split-string/
const splitProcessorDefinition = {
split: {
__template: {
Expand All @@ -469,7 +469,7 @@ const splitProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/sort-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const sortProcessorDefinition = {
sort: {
__template: {
Expand All @@ -481,7 +481,7 @@ const sortProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/trim-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/trim-string/
const trimProcessorDefinition = {
trim: {
__template: {
Expand All @@ -495,7 +495,7 @@ const trimProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/uppercase-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/uppercase-string/
const uppercaseProcessorDefinition = {
uppercase: {
__template: {
Expand All @@ -509,7 +509,7 @@ const uppercaseProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/urldecode-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const urlDecodeProcessorDefinition = {
urldecode: {
__template: {
Expand All @@ -524,7 +524,7 @@ const urlDecodeProcessorDefinition = {
},
};

// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/user-agent-processor.html
// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
const userAgentProcessorDefinition = {
user_agent: {
__template: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@
"{indices}/_bulk",
"{indices}/{type}/_bulk"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/"
"documentation": "https://opensearch.org/docs/latest/api-reference/document-apis/bulk/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
"_cat/aliases",
"_cat/aliases/{name}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-aliases/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@
"_cat/allocation",
"_cat/allocation/{nodes}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-allocation/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"patterns": [
"_cat/cluster_manager"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
"_cat/count",
"_cat/count/{indices}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-count/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-count/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@
"_cat/fielddata",
"_cat/fielddata/{fields}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-field-data/#cat-fielddata"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
"patterns": [
"_cat/health"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-health/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-health/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
"patterns": [
"_cat"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/index/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/index"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@
"_cat/indices",
"_cat/indices/{indices}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-indices/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-indices/"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
"patterns": [
"_cat/master"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/"
"documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/"
}
}
}
Loading

0 comments on commit 2d3dbfc

Please sign in to comment.