Skip to content

[Owner decision needed] docs: staging license domain guidance contradicts the Deployment Helper store page - #2589

Merged
Su (sushmangupta) merged 3 commits into
mainfrom
fix/docs-license-domain-staging-contradiction-draft
Oct 23, 2026
Merged

Su (sushmangupta) merged 3 commits into
mainfrom
fix/docs-license-domain-staging-contradiction-draft

Conversation

@d-kirkland

@d-kirkland Daniel Kirkland (d-kirkland) commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Owner confirmation needed. This PR applies one possible resolution. The platform source cannot decide which is right, so please confirm the rule with the Account/Store owners before merging.

  • Two pages on main give opposite guidance for the Shopware Account license domain of a staging environment:
    • creating-a-staging-instance.md says: "You should still use your live domain in Shopware Account > License Domain to avoid licensing issues."
    • Deployment Helper store.md says "What does change per environment is the license domain" and lists staging.example.com for staging and dev.example.com for dev, with SHOPWARE_STORE_LICENSE_DOMAIN="staging.example.com" # staging in the example.
  • A chatbot answer contradicted itself on exactly this ("do not change the license domain", then "register dev.example.com as an additional license domain").
  • The platform source cannot decide which page is right: it only sends whatever is configured in core.store.licenseHost to the Store. Which domains the Shopware Account accepts, and whether a staging instance may use the live domain or must register its own, is a Store/Account policy outside the repositories.

Options for the owner

  1. The Deployment Helper page is right (several license domains per account, one per environment): the staging page should stop saying "use your live domain" and point to store.md. This is what the diff in this PR does.
  2. The staging page is right (staging reuses the live domain): store.md L63-L64 and L76 must be changed to use the live domain in all environments, and the sentence "Set up multiple domains in your Shopware Account if you need them" (L67) revisited.
  3. Both are conditional (for example Community Edition vs Plus/Enterprise, or dependent on the Account plan): both pages should state the condition and link to each other.

Nothing in this PR is a verified fact about the Account policy.

Platform context (supporting only, does not decide the policy)

In the platform source, a Shopware Account can list several license domains, each verified separately (FirstRunWizardService::getLicenseDomains and verifyLicenseDomain at L229-L253), and each installation uses the one domain set in core.store.licenseHost (including for matching purchase tokens, MatchesLicenceDomain). The source does not say whether a staging or dev instance should use its own domain or the live one; that is for the Account/Store owners to decide.

Related links

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant. (The new relative link was resolved from the page's folder.)
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted. (N/A)
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms. (No new words.)
  • Any required dependent changes in downstream modules have already been merged and published. (N/A)
  • This pull request is ready for review. (The rule still needs the owners' confirmation, see the top of this description.)

Notes

  • This PR was fully AI generated (Claude Code) and requires human review. It has not been merged, approved or reviewed by the AI session.
  • Marked ready for review on request. Please confirm the rule, then adopt, change or close this PR.
  • Found through chatbot answers for one question (answered inconsistently in two runs); the contradiction itself was confirmed by an independent second reader.

🤖 Generated with Claude Code

…ployment Helper (draft, owner decision)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@d-kirkland Daniel Kirkland (d-kirkland) added Improvement PR created to append/modify info in the existing article Info Missed To Document Info Missed To Document labels Oct 13, 2026
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 4b104a3
Preview: https://developer-documentation-fnsjwv0hd-shopware-frontends.vercel.app
Workflow run: #5825

@shopware-dev-docs-connector

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Running.
Repository: shopware/docs
Commit: 17ce26e
Preview: Waiting for workflow logs.

@d-kirkland
Daniel Kirkland (d-kirkland) marked this pull request as ready for review October 20, 2026 08:03
@sushmangupta
Su (sushmangupta) requested review from Soner (shyim) and removed request for Soner (shyim) October 23, 2026 06:57
@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

@sushmangupta
Su (sushmangupta) merged commit f003cae into main Oct 23, 2026
10 checks passed
@sushmangupta
Su (sushmangupta) deleted the fix/docs-license-domain-staging-contradiction-draft branch October 23, 2026 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement PR created to append/modify info in the existing article Info Missed To Document Info Missed To Document

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants