Fix OpenSearch admin docs: prerequisites, capitalization, and env var index#2202
Merged
Vin Le (vienthuong) merged 2 commits intofeat/update-global-admin-es-integrationfrom Mar 20, 2026
Merged
Conversation
Co-authored-by: vienthuong <22548423+vienthuong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [WIP] Address feedback on applying Opensearch globally in admin docs
Fix OpenSearch admin docs: prerequisites, capitalization, and env var index
Mar 20, 2026
Vin Le (vienthuong)
approved these changes
Mar 20, 2026
Vin Le (vienthuong)
merged commit 3824567
into
feat/update-global-admin-es-integration
1 check failed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Five documentation issues in the OpenSearch admin feature docs, all stemming from missing prerequisite context and inconsistent terminology.
Changes
elasticsearch-setup.mdYOUR OPEN SEARCH URL→YOUR OPENSEARCH URLADMIN_OPENSEARCH_URLandSHOPWARE_ADMIN_ES_ENABLED=1must be set beforeENABLE_OPENSEARCH_FOR_ADMIN_API=1has any effectperformance-tweaks.mdElasticsearch/Opensearch→Elasticsearch/OpenSearchENABLE_OPENSEARCH_FOR_ADMIN_APIparagraph to explicitly state the Admin OpenSearch prerequisite before recommending the flagenvironment-variables.mdENABLE_OPENSEARCH_FOR_ADMIN_APIto the env var reference table (alphabetically ordered), with prerequisites, experimental status, andsince 6.7.9.0noted✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.