Team DX is serving the teams to provide documentation to our customers.
Shopware has its history of creating and maintaining self-build and self-hosted documentations, which went wild after the initial deployment, because there was no dedicated "owner" who directly maintained the docs and fixed bugs etc.
We want to make it easy for everyone to set up and maintain / preview / deploy the new documentation and have a dedicated "ownership" so people have less to worry about. Ultimately - we want the majority of teams to adopt that approach, not being force into. 🙂
This repository:
- provides Shopware Docs CLI (
./docs-cli.cjs) for embedding, previewing and managing embedded resources - reuses our official Vitepress-based
template
shopware/developer-documentation-vitepress - embeds static files from a dedicated
docsfolder (source) in sub-repositories/projects to thesrc/<mount-point>folder (destination) in this repository: - has a single deployment workflow with the build being served from a single domain - Developer Portal
Note: This repository does not include layouts, templates and other components - these are provided by the
developer-documentation-vitepress.
See QUICK START for more info on how to start using Developer Portal, including some basic examples on how to embed and manage docs repos, and preview the dev and prod builds.
For a ready-to-code example, see DevContainer powered by GitHub Codespaces, VSCode Dev Container or similar solution.
| Section | Description |
|---|---|
| Quick start | Set up your local Developer portal instance and start using CLI |
| CLI | In-depth description for all features provided by the Shopware Docs CLI |
| Features | In-depth description for all features provided by thedeveloper-documentation-vitepres |
| Features (external) | In-depth description for all features provided by the developer-documentation-vitepress |
| Tests | Walkthrough for tests |
| FAQ | Frequently asked questions |
| DevContainer | Using Shopware Docs with DevContainer |