Skip to content

docs: add content as first draft for participant and owner pages #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sabinem wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add content as first draft for participant and owner pages #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8f6f2a
docs: add content to pages
sabinem Oct 23, 2026
46521ab
docs: describe every sidebar page, with links between them
sabinem Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion docs/src/owner/manage-forms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Manage Forms

The questions people answer when they register, and their answers.
:::{admonition} Owner's Manage Forms

The questions people answer when they register. It shows:

- [Registration form](#registration-form): the questions, in order
- [A question](#a-question): its type, options and settings

It might also show:

- [Answers](#answers): once someone has answered

:::

![The Manage Forms page of a hackathon, as its owner sees it](../static/screenshots/manage-forms.png)

## Registration form

- **New question**; **Edit** and **Delete** per question.
- Once people have answered, type, options and **Required** are locked, and
deleting a question discards its answers.

## A question

- **Key**, **Question**, **Answer type**, **Position**, **Required**.
- **Show answers to participants**: answers are shared on
[Participants](../participant/member-participants.md).
- **Options** for choice questions, one per line.

## Answers

- **See the answers**: per question, who answered and what.
- Each person's answers are also on
[Manage Participants](manage-participants.md).
- Answers help you form teams, see [Manage Teams](manage-teams.md).
31 changes: 29 additions & 2 deletions docs/src/owner/manage-invites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
# Invitations

Only in a private hackathon: the links that let invited people see it and ask to
join.
:::{admonition} Owner's Invitations

The links that let people into a private hackathon. Only for private hackathons.
It shows:

- [Live links](#live-links): links that work, to copy or revoke
- [New link](#new-link): create another one

It might also show:

- [No longer working](#no-longer-working): revoked and expired links

:::

![The Invitations page of a hackathon, as its owner sees it](../static/screenshots/manage-invites.png)

## Live links

- Copy a link into an email; **Revoke** it if it spreads.
- Someone with a valid link joins straight away, without the waitlist.
- Links work only while registration is open, see
[Settings](manage-settings.md).

## New link

- An optional note on who it is for; **Create link**.
- A link stops working when the hackathon ends.

## No longer working

- Revoked or expired links, for reference.
22 changes: 20 additions & 2 deletions docs/src/owner/manage-pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Manage Pages

The hackathon's own pages, such as rules or a schedule, which participants find
in the menu.
:::{admonition} Owner's Manage Pages

The hackathon's own pages, such as rules or a schedule. It shows:

- [Pages](#pages): every page, in menu order
- [A page](#a-page): title, visibility and content

:::

![The Manage Pages page of a hackathon, as its owner sees it](../static/screenshots/manage-pages.png)

## Pages

- Drag or use the arrows to change the order in the menu.
- The eye shows or hides a page for participants.
- **View** shows it as participants see it; **Edit** changes it.

## A page

- **New page**: **Title**, **Visible to participants**, **Content** in Markdown.
- Visible pages appear in every participant's menu.
- **Delete this page**.
34 changes: 33 additions & 1 deletion docs/src/owner/manage-participants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# Manage Participants

Everyone who registered, and the people waiting for your approval.
:::{admonition} Owner's Manage Participants

Everyone who registered. It shows:

- [Participants](#participants): the roster, with search and CSV download
- [A person](#a-person): answers, teams, and what you can change

It might also show:

- [Waitlist](#waitlist): people waiting for your approval

:::

![The Manage Participants page of a hackathon, as its owner sees it](../static/screenshots/manage-participants.png)

## Participants

- How many there are, who has no email address, who answered the
[registration form](manage-forms.md).
- **Download CSV**: everyone, waitlist included.
- **Manage** opens a person.

## Waitlist

- On a public hackathon, everyone who registers waits here.
- **Review** opens the person, so you can approve or decline them.
- Only owners see the waitlist.

## A person

- All registration answers, including those not shared.
- Their teams, see [Manage Teams](manage-teams.md).
- **Approve** or **Decline** someone waiting.
- **Make owner** / **Remove owner**.
- **Remove from hackathon**; for an owner, remove the owner role first.
29 changes: 28 additions & 1 deletion docs/src/owner/manage-projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# Manage Projects

Every project, including proposals waiting for your review.
:::{admonition} Owner's Manage Projects

Every project, whatever its status. It shows:

- [Projects by status](#projects-by-status): approved, awaiting review, rejected
- [Review](#review): approve or reject a project
- [New project](#new-project): add one yourself

:::

![The Manage Projects page of a hackathon, as its owner sees it](../static/screenshots/manage-projects.png)

## Projects by status

- Tabs **Approved**, **Awaiting review**, **Rejected**.
- **Download CSV**: all projects.
- **Review** or **Edit** per project.

## Review

- **Approve**, **Reject** (with an optional reason), **Revoke approval** or
**Reconsider**.
- Only approved projects appear on [Projects](../participant/member-projects.md)
and on [Manage Teams](manage-teams.md).

## New project

- **New Project**: the same form participants use to propose.
- Participants propose only while you allow it, see
[Settings](manage-settings.md).
22 changes: 20 additions & 2 deletions docs/src/owner/manage-public.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Manage Public Page

The hackathon as everyone outside it sees it: its name, dates, picture and
description, with a preview beside the fields.
:::{admonition} Owner's Manage Public Page

The hackathon as everyone outside it sees it. It shows:

- [The form](#the-form): name, visibility, dates, logo and description
- [The preview](#the-preview): what visitors will see

:::

![The Manage Public Page page of a hackathon, as its owner sees it](../static/screenshots/manage-public.png)

## The form

- **Name**, **Visibility** (public or private), **Starts at**, **Ends at**,
**Logo URL**, **Description**.
- Private hackathons are reached through [Invitations](manage-invites.md).
- Dates can be changed but not removed once set.
- **Save changes** returns to [Settings](manage-settings.md).

## The preview

- Updates as you type.
35 changes: 23 additions & 12 deletions docs/src/owner/manage-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# Settings

Settings is the first page under **Manage Hackathon** in your hackathon's menu.
:::{admonition} Owner's Settings

The first page under **Manage Hackathon**. It shows:

- [What participants can do](#what-participants-can-do): the checkboxes that
steer the hackathon
- **Where the hackathon is**: the current and next phase, see
[Manage Timeline](manage-timeline.md)
- **Tracks**: optional, see [Manage Tracks](manage-tracks.md)
- **Manage**: a tile for every other page under **Manage Hackathon**

:::

![The Settings page of a hackathon, as its owner sees it](../static/screenshots/manage-settings.png)

Expand All @@ -18,14 +29,14 @@ The checkboxes are grouped into steps, in the order a hackathon usually runs.
Some steps are optional, and some only point you to the page where you prepare
the next one. Moving the hackathon to another phase never changes them.

| Step | Checkbox | When it is on, participants can … | Good to know |
| ---------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1. Register | Open registration | join the hackathon. On a public hackathon they wait until you approve them; on a private one, a valid invitation lets them straight in. | While it is off, invitation links don't work either. Nobody can join once the end date has passed. See [Manage Forms](manage-forms.md), [Invitations](manage-invites.md) and [Manage Participants](manage-participants.md). |
| 2. Projects | Participants can propose projects | propose projects for you to review. | Optional: leave it off if you add all projects yourself. See [Manage Projects](manage-projects.md) and [Projects](../participant/member-projects.md). |
| 3. Project preferences | Participants can voice preferences | mark the projects they would like to work on. | Turning it off freezes the preferences as they are. See [Projects](../participant/member-projects.md). |
| 4. Team assignments | — | — | You form the teams. Participants don't see them until the next step. See [Manage Teams](manage-teams.md). |
| 5. Hacking starts | Participants can see teams | see the teams and who is on them. | While it is off, participants can't see even their own team. See [Teams](../participant/member-teams.md). |
| | Participants can submit for their team | hand in work for their team's project. | Only people on a team can submit. Turning it off stops new submissions, but a team can still finalize a draft it has started. See [Manage Submissions](manage-submissions.md) and [Submissions](../participant/member-submissions.md). |
| 6. Set up voting | — | — | Create the vote categories and decide who votes in them. See [Manage Voting](manage-voting.md). |
| 7. Voting starts | Participants can vote | vote, and see every team's submissions instead of only their own team's. | This opens all vote categories at once. Only its jury votes in a jury category, and nobody can vote for their own team. See [Voting](../participant/member-voting.md). |
| 8. Publish results | Publish results | see the vote results. | There is no separate step to publish a single result: everything recorded becomes visible the moment this is on. You always see the results yourself. See [Manage Voting](manage-voting.md) and [Results](../participant/member-results.md). |
| Step | Checkbox | When it is on, participants can … | Good to know |
| ---------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1. Register | Open registration | join the hackathon. On a public hackathon they wait until you approve them; on a private one, a valid invitation lets them straight in. | While it is off, invitation links don't work either. Nobody can join once the end date has passed. See [Manage Forms](manage-forms.md), [Invitations](manage-invites.md) and [Manage Participants](manage-participants.md). |
| 2. Projects | Participants can propose projects | propose projects for you to review. | Optional: leave it off if you add all projects yourself. See [Manage Projects](manage-projects.md) and [Projects](../participant/member-projects.md). |
| 3. Project preferences | Participants can voice preferences | mark the projects they would like to work on. | Turning it off freezes the preferences as they are. See [Projects](../participant/member-projects.md). |
| 4. Team assignments | — | — | You form the teams. Participants don't see them until the next step. See [Manage Teams](manage-teams.md). |
| 5. Hacking starts | Participants can see teams | see the teams and who is on them. | While it is off, participants can't see even their own team. See [Teams](../participant/member-teams.md). |
| | Participants can submit for their team | hand in work for their team's project. | Only people on a team can submit. Turning it off stops new submissions, but a team can still finalize a draft it has started. See [Manage Submissions](manage-submissions.md) and [Submissions](../participant/member-submissions.md). |
| 6. Set up voting | — | — | Create the vote categories and decide who votes in them. See [Manage Voting](manage-voting.md). |
| 7. Voting starts | Participants can vote | vote, and see every team's submissions instead of only their own team's. | This opens all vote categories at once, and nobody can vote for their own team. Switch it off to close voting before you make the results final. See [Manage Voting](manage-voting.md) and [Voting](../participant/member-voting.md). |
| 8. Publish results | Publish results | see the vote results. | Make the results final on [Manage Voting](manage-voting.md) first; this then shows them. You always see the results yourself. See [Results](../participant/member-results.md). |
25 changes: 24 additions & 1 deletion docs/src/owner/manage-submissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Manage Submissions

Every team and where it stands with its submission.
:::{admonition} Owner's Manage Submissions

Every team and where it stands with its work. It shows:

- [Status](#status): whether submitting is open
- [Teams](#teams): each team's entry and drafts

:::

![The Manage Submissions page of a hackathon, as its owner sees it](../static/screenshots/manage-submissions.png)

## Status

- **Submissions are open** or **closed**; change it on
[Settings](manage-settings.md).

## Teams

- Tabs **All**, **No submission**, **Draft only**, **Final**; search by team,
project or person.
- **Download CSV**: all teams.
- Per team: members, the entry, its version and who submitted it; earlier
versions folded away.
- Read-only: teams hand in and finalize themselves on
[Submissions](../participant/member-submissions.md).
- No teams yet: **Set up teams** leads to [Manage Teams](manage-teams.md).
54 changes: 53 additions & 1 deletion docs/src/owner/manage-teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,57 @@
# Manage Teams

Forming the teams and deciding who is on which.
:::{admonition} Owner's Manage Teams

Where you form the teams. It shows:

- [Projects](#projects): each approved project with its teams
- [Unassigned](#unassigned): confirmed participants without a team
- [Filters and cards](#filters-and-cards): registration answers and preferences
- [Spreadsheet](#spreadsheet): download and upload a CSV

It might also show:

- [Teams are fixed](#teams-are-fixed): once teams are published or work is
handed in

:::

![The Manage Teams page of a hackathon, as its owner sees it](../static/screenshots/manage-teams.png)

## Projects

- One card per [approved project](manage-projects.md), with **N want in** and
its teams.
- **+ Add Team**; rename or delete a team.
- Drag people between teams.

## Unassigned

- Filter by registration answer or preferred project; **Reset filters**.

## Filters and cards

- **Registration questions**: short names, filters and **Show on cards**, see
[Manage Forms](manage-forms.md).
- **Project preferences**: what participants chose on
[Projects](../participant/member-projects.md#preferences).
- **Find a person** searches the page.

## Spreadsheet

- **Download CSV**: everyone with preferences and answers.
- Edit the `project` and `team` columns, then **Upload CSV**; it replaces all
teams.
- **How assignment works** explains the format.

## Saving

- Nothing is stored until **Save**; **Discard** drops your changes.
- Saving deletes empty teams.
- Participants see the teams only once you let them, see
[Settings](manage-settings.md).

## Teams are fixed

- Once teams are published or a team has handed in work: no upload, no deleting
teams. Moving people, renaming and adding teams still work.
Loading
Loading