[docs] Document deprecation of top-level url/admin_api in favor of environments - #2462
Draft
shopware-docs-updater[bot] wants to merge 1 commit into
Draft
Conversation
…ironments Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Developer Docs healthcheckStatus: Completed with |
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.
Follow-up docs for shopware/shopware-cli#1405 (author:
@shyim, merged via cursor[bot] PR).User-facing change
That PR deprecates the top-level
urlandadmin_apikeys in.shopware-project.ymlin favor of namedenvironments(an empty-e/--envnow defaults toenvironments.local).project createandproject config initnow only writeenvironments.local, and the CLI logs a deprecation warning when a config still uses the top-level keys.Documentation gap
Our config reference examples still showed a stale top-level
url:key alongsideenvironments.local, which contradicted the new deprecated/preferred layout, andproject config initdocs didn't mention where credentials are written or that the old keys are deprecated.Files changed
guides/development/dev-environment.md— removed the stale top-levelurlexample and added a note thaturl/admin_apiat the top level are deprecated in favor ofenvironments(empty-edefaults toenvironments.local).products/tools/cli/project-commands/helper-commands.md— clarified thatproject config initwritesenvironments.localand noted the deprecation warning for top-level keys.No other docs pages referenced the deprecated top-level layout in a way that needed changes.