https://github.com/shopware/developer-portal
Home page for developers
https://github.com/shopware/developer-portal
docs
Last synced: 11 months ago
JSON representation
Home page for developers
- Host: GitHub
- URL: https://github.com/shopware/developer-portal
- Owner: shopware
- Created: 2022-11-08T15:40:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-18T18:09:38.000Z (12 months ago)
- Last Synced: 2025-06-18T19:25:05.257Z (12 months ago)
- Topics: docs
- Language: TypeScript
- Homepage: https://developer.shopware.com
- Size: 31.5 MB
- Stars: 10
- Watchers: 6
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shopware Developer Portal
[](https://github.com/shopware/developer-portal/actions/workflows/checkout-test-build-deploy.yml)
[](https://github.com/shopware/developer-portal/issues)
[](https://github.com/shopware/developer-portal/pull-requests)
[](https://developer.shopware.com)
[](https://github.com/shopware/developer-portal)
[](https://github.com/codespaces/new?machine=basicLinux32gb&repo=563429368&ref=main&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestEurope)
_**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. :slightly_smiling_face:
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`](https://github.com/shopware/developer-documentation-vitepress)
- **embeds static files** from a dedicated `docs` folder (source) in sub-repositories/projects to
the `src/`
folder (destination) in this repository:
- [shopware/docs](https://github.com/shopware/docs)
- [shopware/frontends](https://github.com/shopware/frontends)
- [shopware/meteor](https://github.com/shopware/meteor)
- [shopware/release-notes](https://github.com/shopware/release-notes)
- [shopware/store-api-reference](https://github.com/shopware/store-api-reference)
- [shopware/admin-api-reference](https://github.com/shopware/admin-api-reference)
- **has a single deployment workflow** with the build being served from a single
domain - [Developer Portal](https://developer.shopware.com)
_Note: This repository does not include layouts, templates and other components - these are provided by the
`developer-documentation-vitepress`._
# Setup
See [QUICK START](./QUICK-START.md) 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](./DEV-CONTAINER.md) powered by GitHub Codespaces, VSCode Dev Container
or similar solution.
# Table of contents
| Section | Description |
|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| [Quick start](./QUICK-START.md) | Set up your local Developer portal instance and start using CLI |
| [CLI](https://github.com/shopware/developer-documentation-vitepress/blob/main/CLI.md) | In-depth description for all features provided by the Shopware Docs CLI |
| [Features](./FEATURES.md) | In-depth description for all features provided by the`developer-documentation-vitepres` |
| [Features (external)](https://github.com/shopware/developer-documentation-vitepress/blob/main/FEATURES.md) | In-depth description for all features provided by the `developer-documentation-vitepress` |
| [Tests](./TESTS.md) | Walkthrough for tests |
| [FAQ](./FAQ.md) | Frequently asked questions |
| [DevContainer](./DEV-CONTAINER.md) | Using Shopware Docs with DevContainer |