Example How-to Guide
Template demonstrating the recommended structure for task-based documentation.
Example How-to: Publish a New Event
Use this template whenever you document a repeatable task. Swap the content with the real workflow, but keep the structure intact.
Goal
Publish a new event that appears on the public web app with localized content and the correct registration link.
Prerequisites
- Access to the Admin App with the
editororadminrole. - Event assets ready (cover image, description, ticket info).
- Optional: External registration link (Eventbrite, Hoopla, etc.).
If you only need to update an existing event, jump to Step 3 and edit the existing record instead of creating a new one.
Steps
Open the events module
Log into the Admin App and navigate to /admin/events. Click New Event.
Fill out event details
Enter the title, date, location, and description in Norwegian first. Use the language toggle to provide English translations.
Attach image + registration
Upload a cover image (3:2 aspect ratio). Select Registration → choose Internal (Appwrite form) or External (paste the URL).
Publish & verify
Click Publish. Visit /events on the Web App to confirm the new event appears in both locales.
Optional commands
Use the commands below if you need to preview the change locally before releasing it.
bun run dev --filter=admin
bun run dev --filter=web # in another terminalVerification
- The event appears on
/eventsand/no/events. - Clicking the event shows the correct localized content.
- Registration links or forms load as expected.
Troubleshooting
- Event missing? Double-check that the event status is set to
published. - Wrong order? Update the event date/time or use the manual ordering field in the admin list view.
- Broken image? Confirm the file uploaded to the
eventsstorage bucket in Appwrite and that the URL is HTTPS.