shopware / shopware/shopware

Add day-to-day work examples to the Meteor Admin Documentation

Open
#16,549 0 comments 0 reactions 0 assignees View on GitHub
component/administration domain/framework
Dominant language
PHP
Stars
3.4k
Forks
1.2k
Avg merge
3d 55m
Merged PRs (30d)
436

Description

### Technical TODO

Currently the documentation only shows the Installation and API. It lacks examples/tutorials that users can work through to familiarize with the SDK.

Split it into these sections (as proposed by Lauri):

- [ ] **Development Cycle, including:**
- using Vue DevTools
- Finding Extension Points
- PositionId Discovery
- [ ] **Deployment**
- Bundling
- (Hosting?)
- [ ] **Running / Operating**
- Logging?
- [ ] **Updating / Maintenance**
- Handling Shopware upgrades and breaking changes
- Pushing a new version to the shops

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing Meteor Admin documentation for its Installation and API sections. Define the scope and structure for tutorials covering development, deployment, operation, and maintenance, then consider the work complete when each agreed day-to-day example is documented and usable by SDK users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.