huge documentaton restructure for docusaurus
This commit is contained in:
Codex Agent
37
docs/help/en/admin/admin-issue-resolution.md
Normal file
37
docs/help/en/admin/admin-issue-resolution.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "Troubleshooting & Issue Resolution"
|
||||
locale: en
|
||||
slug: admin-issue-resolution
|
||||
audience: admin
|
||||
summary: "Playbooks for the most common admin-side incidents, from stuck uploads to billing locks."
|
||||
version_introduced: 2025.4
|
||||
requires_app_version: "^3.2.0"
|
||||
status: draft
|
||||
translation_state: aligned
|
||||
last_reviewed_at: 2025-02-22
|
||||
owner: reliability@fotospiel.app
|
||||
related:
|
||||
- slug: live-ops-control
|
||||
- slug: privacy-and-support
|
||||
---
|
||||
|
||||
## Upload incidents
|
||||
| Symptom | Diagnosis | Fix |
|
||||
| --- | --- | --- |
|
||||
| Queue stuck >10 min | Check Live Ops health widget | Run `php artisan media:backfill-thumbnails --tenant=XYZ` then reopen event |
|
||||
| Specific guest blocked | Guest reached per-device limit | Increase limit under Event → Upload rules or ask them to clear drafts |
|
||||
| Photos missing EXIF | Guest imported screenshots | No action; remind them that EXIF is optional |
|
||||
|
||||
## Access issues
|
||||
- **Admin cannot log in**: verify invite accepted; reset via *Team → Resend invite*. Check SSO mapping if enforced.
|
||||
- **Guest cannot join**: confirm event status is *Published* and share direct join URL `https://app.fotospiel.com/join/<code>`.
|
||||
|
||||
## Billing & quotas
|
||||
- Paddle webhook failure locks uploads: check `storage/logs/paddle.log`, re-send webhook via Paddle dashboard, then toggle the subscription status.
|
||||
- Storage 90% full: run archive early or purchase add-on via Paddle customer portal.
|
||||
|
||||
## Communication templates
|
||||
Reuse the canned responses under `docs/content/fotospiel_howto_artikel_detailliert.md` to keep messaging consistent.
|
||||
|
||||
### Need more help?
|
||||
Escalate to reliability@fotospiel.app with the event ID, customer account, and timestamp. Attach screenshots/logs when possible.
|
||||
38
docs/help/en/admin/event-prep-checklist.md
Normal file
38
docs/help/en/admin/event-prep-checklist.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: "Event Preparation Checklist"
|
||||
locale: en
|
||||
slug: event-prep-checklist
|
||||
audience: admin
|
||||
summary: "A 48-hour countdown to ensure devices, guests, and automations are ready before doors open."
|
||||
version_introduced: 2025.4
|
||||
requires_app_version: "^3.2.0"
|
||||
status: draft
|
||||
translation_state: aligned
|
||||
last_reviewed_at: 2025-02-22
|
||||
owner: ops@fotospiel.app
|
||||
related:
|
||||
- slug: live-ops-control
|
||||
- slug: post-event-wrapup
|
||||
---
|
||||
|
||||
## 48–24 hours before
|
||||
- [ ] Create the event in the Admin app with correct timezone + retention policy.
|
||||
- [ ] Upload cover artwork (1200×630) and ensure translations exist for titles/descriptions.
|
||||
- [ ] Import guest lists or generate QR badges if needed.
|
||||
- [ ] Test push notification templates (reminders, achievement unlocks).
|
||||
|
||||
## 24–2 hours before
|
||||
- [ ] Run `tenant:attach-demo-event` in staging to rehearse workflow with staff.
|
||||
- [ ] Print or display the join QR near entrance and photobooth areas.
|
||||
- [ ] Prepare onsite Wi-Fi SSID/password signage.
|
||||
- [ ] Confirm that automatic moderation rules match the client contract (e.g., block explicit content, require approval).
|
||||
- [ ] Verify Paddle/RevenueCat status dashboards show green.
|
||||
|
||||
## Final 2 hours
|
||||
- [ ] Clear demo data from the live event.
|
||||
- [ ] Open the guest app on test devices and complete the getting-started flow.
|
||||
- [ ] Start the Live Ops screen on a tablet/laptop near the stage.
|
||||
- [ ] Brief staff on escalation paths (support contacts, backup devices, photo guidelines).
|
||||
|
||||
### Need more help?
|
||||
Open `live-ops-control` for real-time monitoring tips or reach out to ops@fotospiel.app.
|
||||
25
docs/help/en/admin/index.md
Normal file
25
docs/help/en/admin/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "Customer Admin Help Center"
|
||||
locale: en
|
||||
slug: admin-help-index
|
||||
audience: admin
|
||||
summary: "Operational playbooks for event owners: onboarding, event setup, live control, and post-event delivery."
|
||||
version_introduced: 2025.4
|
||||
status: draft
|
||||
translation_state: aligned
|
||||
last_reviewed_at: 2025-02-22
|
||||
owner: cx-team@fotospiel.app
|
||||
related: []
|
||||
---
|
||||
|
||||
This portal collects everything event admins need to configure customer accounts, run events smoothly, and resolve issues quickly. Articles are grouped by lifecycle:
|
||||
|
||||
| Phase | Key Questions | Article Slug |
|
||||
| --- | --- | --- |
|
||||
| Account Setup | How do I invite staff and configure branding? | `tenant-dashboard-overview` |
|
||||
| Event Preparation | What checklists should I complete before doors open? | `event-prep-checklist` |
|
||||
| Live Operations | How do I monitor uploads, moderate content, and trigger announcements? | `live-ops-control` |
|
||||
| Wrap-up & Compliance | How are exports, archives, and privacy handled? | `post-event-wrapup` |
|
||||
| Troubleshooting | How to handle upload issues, device loss, billing, etc. | `admin-issue-resolution` |
|
||||
|
||||
Use the navigation sidebar inside the admin app for faster access, or open `/help/admin` in a desktop browser for the full layout with breadcrumbs and related links.
|
||||
39
docs/help/en/admin/live-ops-control.md
Normal file
39
docs/help/en/admin/live-ops-control.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Live Ops Control"
|
||||
locale: en
|
||||
slug: live-ops-control
|
||||
audience: admin
|
||||
summary: "Monitor uploads, moderate content, and push announcements while the event is live."
|
||||
version_introduced: 2025.4
|
||||
requires_app_version: "^3.2.0"
|
||||
status: draft
|
||||
translation_state: aligned
|
||||
last_reviewed_at: 2025-02-22
|
||||
owner: ops@fotospiel.app
|
||||
related:
|
||||
- slug: event-prep-checklist
|
||||
- slug: admin-issue-resolution
|
||||
---
|
||||
|
||||
## Dashboard widgets
|
||||
- **Upload throughput** – photos/minute, highlighted when backlog >25.
|
||||
- **Device health** – top devices experiencing errors (permission denied, storage full).
|
||||
- **Moderation queue** – flagged photos awaiting approval; assign to moderators.
|
||||
- **Announcements** – compose push/banner messages; supports locale-specific text.
|
||||
|
||||
## Typical workflow
|
||||
1. Pin the Live Ops page on a tablet. Set auto-refresh to 15 seconds.
|
||||
2. Watch the throughput graph as doors open; expect spike to 40+/min right after ceremonies.
|
||||
3. If backlog grows, broadcast a banner reminding guests to stay online or reduce burst uploads.
|
||||
4. Moderate flagged items quickly; policies require action within 10 minutes.
|
||||
5. Use the *Achievement trigger* widget to award badges manually if automation criteria fail.
|
||||
|
||||
## Escalation matrix
|
||||
| Issue | First action | Escalate to |
|
||||
| --- | --- | --- |
|
||||
| Upload queue stuck | Run health check → re-sync event | Reliability on-call |
|
||||
| Offensive content | Hide photo → download evidence → notify organizer | Legal duty officer |
|
||||
| Billing lock | Check Paddle dashboard → confirm payment status | Finance |
|
||||
|
||||
### Need more help?
|
||||
Open `admin-issue-resolution` for detailed troubleshooting or ping #ops-help in Slack.
|
||||
33
docs/help/en/admin/post-event-wrapup.md
Normal file
33
docs/help/en/admin/post-event-wrapup.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: "Post-Event Wrap-up"
|
||||
locale: en
|
||||
slug: post-event-wrapup
|
||||
audience: admin
|
||||
summary: "Export highlights, archive data, and fulfill privacy obligations within 72 hours after the event."
|
||||
version_introduced: 2025.4
|
||||
requires_app_version: "^3.2.0"
|
||||
status: draft
|
||||
translation_state: aligned
|
||||
last_reviewed_at: 2025-02-22
|
||||
owner: success@fotospiel.app
|
||||
related:
|
||||
- slug: event-prep-checklist
|
||||
- slug: privacy-and-support
|
||||
---
|
||||
|
||||
## First 24 hours
|
||||
- Send thank-you push/email with curated highlights (select up to 40 photos → *Share link*).
|
||||
- Export admin CSV (uploads, likes, reports) for your records.
|
||||
- Review moderation queue to ensure no reports remain unresolved.
|
||||
|
||||
## Within 72 hours
|
||||
- Trigger the *Archive & purge* action (Settings → Data Lifecycle). This copies media to cold storage and deletes transient caches.
|
||||
- Provide guests with download links if promised in the contract.
|
||||
- If GDPR deletion requests were filed, confirm completion and record the ticket ID.
|
||||
|
||||
## Optional follow-up
|
||||
- Duplicate the event as a template for future productions.
|
||||
- Update `docs/process/todo/` with learnings or improvements for the product team.
|
||||
|
||||
### Need more help?
|
||||
Reach success@fotospiel.app or consult the Legal Pages resource for compliance wording.
|
||||
34
docs/help/en/admin/tenant-dashboard-overview.md
Normal file
34
docs/help/en/admin/tenant-dashboard-overview.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "Customer Control Center Overview"
|
||||
locale: en
|
||||
slug: tenant-dashboard-overview
|
||||
audience: admin
|
||||
summary: "Invite staff, configure branding, and understand how customer-wide settings affect every event."
|
||||
version_introduced: 2025.4
|
||||
requires_app_version: "^3.2.0"
|
||||
status: draft
|
||||
translation_state: aligned
|
||||
last_reviewed_at: 2025-02-22
|
||||
owner: onboarding@fotospiel.app
|
||||
related:
|
||||
- slug: event-prep-checklist
|
||||
- slug: admin-issue-resolution
|
||||
---
|
||||
|
||||
## When to read this
|
||||
Right after receiving access to a new customer account or when onboarding new staff. The Customer Control Center lives in the Admin app (Filament) and mirrors most options on desktop.
|
||||
|
||||
## Key areas
|
||||
1. **Home** – snapshot of live events, storage usage, unresolved reports.
|
||||
2. **Team** – invite admins via email, assign roles (Owner, Manager, Moderator). SSO via Azure AD/Google is available if enabled in customer settings.
|
||||
3. **Branding** – upload logos, choose accent colors, set localized welcome text shown in the guest app.
|
||||
4. **Legal pages** – edit Impressum/Privacy/AGB via the Legal resource; changes propagate instantly.
|
||||
5. **Integrations** – manage Paddle keys, RevenueCat app IDs, webhooks, and Zapier tokens. Never paste secrets into articles.
|
||||
|
||||
## Best practices
|
||||
- Keep at least two Owner-level accounts for redundancy.
|
||||
- Use the staging customer account to test branding or automation before touching production.
|
||||
- Document invitations in the change log (`docs/process/changes/`).
|
||||
|
||||
### Need more help?
|
||||
See `event-prep-checklist` for event-level prep or contact cx-team@fotospiel.app for onboarding assistance.
|
||||
Reference in New Issue
Block a user