diff --git a/docs/src/index.md b/docs/src/index.md index 607a35ac..d8de7d19 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,22 +4,22 @@ Hackagon is the Swiss Data Science Center's platform for running hackathons. ## What is a hackathon on Hackagon? -On this platform a hackathon is: - -- an **event** that lasts one or several days; -- **run by** one or several **hackathon owners**; -- joined by **participants**, whose registrations the owners approve or reject; -- **public or private**; -- built around **projects**, which owners add or participants propose, and which - the owners approve or reject; -- worked on in **teams**, which the owners form from the participants' - registration answers and their project preferences; -- handed in as **submissions**: every member of a team can submit, submissions - are versioned, and one can be marked as final; other teams can see final - submissions; -- decided by **voting**, which the owners set up in categories: in each category - participants either pick one project or spread a budget of points across the - projects. +On this platform: + +- A hackathon is an **event** that lasts one or several days. +- It is **run by** one or several **hackathon owners**. +- **Participants** join it. The owners approve or reject their registrations. +- A hackathon is **public or private**. +- It is built around **projects**. Owners add projects or participants propose + them, and the owners approve or reject them. +- Participants work in **teams**. The owners form the teams from the + participants' registration answers and project preferences. +- Teams hand in **submissions**. Every team member can submit, submissions are + versioned, and one can be marked as final. Other teams can see final + submissions. +- **Voting** decides the outcome. The owners set it up in categories. In each + category participants either pick one project or spread a budget of points + across the projects. ## Roles @@ -38,11 +38,11 @@ This first version covers hackathon owners and participants. ## Limitations -- The platform is not a place for data and code to live; +- The platform is not a place for data and code to live. [Renku](https://renkulab.io/) is one such place. - The platform does not organize anything on site. To get help organizing a hackathon, email us at - [hackathon@datascience.ch](mailto:hackathon@datascience.ch); we offer + [hackathon@datascience.ch](mailto:hackathon@datascience.ch). We offer different packages. ```{toctree} diff --git a/docs/src/owner/index.md b/docs/src/owner/index.md index 478b4867..835a97db 100644 --- a/docs/src/owner/index.md +++ b/docs/src/owner/index.md @@ -2,8 +2,8 @@ This guide is for hackathon owners: the people who set up and run a hackathon. -The pages under **Manage Hackathon** in a hackathon's menu, in the order they -appear there: +The pages under {guilabel}`Manage Hackathon` in a hackathon's menu, in the order +they appear there: ```{toctree} :maxdepth: 1 diff --git a/docs/src/owner/manage-forms.md b/docs/src/owner/manage-forms.md index 97a52e8c..45e527a5 100644 --- a/docs/src/owner/manage-forms.md +++ b/docs/src/owner/manage-forms.md @@ -1,5 +1,38 @@ # 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 + +- Click {guilabel}`New question` to add a question. Click {guilabel}`Edit` or + {guilabel}`Delete` next to a question to change or remove it. +- Once people have answered, type, options and {guilabel}`Required` are locked, + and deleting a question discards its answers. + +## A question + +- Enter the {guilabel}`Key`, {guilabel}`Question`, {guilabel}`Answer type` and + {guilabel}`Position`. Tick {guilabel}`Required` if everyone must answer. +- Tick {guilabel}`Show answers to participants` to share the answers on + [Participants](../participant/member-participants.md). +- For choice questions, enter the {guilabel}`Options`, one per line. + +## Answers + +- Click {guilabel}`See the answers` to see, 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). diff --git a/docs/src/owner/manage-invites.md b/docs/src/owner/manage-invites.md index 074b0d20..3ec311d5 100644 --- a/docs/src/owner/manage-invites.md +++ b/docs/src/owner/manage-invites.md @@ -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. Click {guilabel}`Revoke` 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 + +- Enter an optional note on who it is for, then click {guilabel}`Create link`. +- A link stops working when the hackathon ends. + +## No longer working + +- Revoked or expired links, for reference. diff --git a/docs/src/owner/manage-pages.md b/docs/src/owner/manage-pages.md index ce053514..50fc90f8 100644 --- a/docs/src/owner/manage-pages.md +++ b/docs/src/owner/manage-pages.md @@ -1,6 +1,27 @@ # 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. +- Click the eye to show or hide a page for participants. +- Click {guilabel}`View` to see a page as participants do, or {guilabel}`Edit` + to change it. + +## A page + +- Click {guilabel}`New page`, then enter a {guilabel}`Title` and the + {guilabel}`Content` in Markdown. Tick {guilabel}`Visible to participants` to + show it. +- Visible pages appear in every participant's menu. +- Click {guilabel}`Delete this page` on a page's edit form to remove it. diff --git a/docs/src/owner/manage-participants.md b/docs/src/owner/manage-participants.md index 2ffb9147..4cb1b4d8 100644 --- a/docs/src/owner/manage-participants.md +++ b/docs/src/owner/manage-participants.md @@ -1,5 +1,38 @@ # 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). +- Click {guilabel}`Download CSV` to get everyone, waitlist included. +- Click {guilabel}`Manage` to open a [person's details](#a-person) + +## Waitlist + +- On a public hackathon, everyone who registers waits here. +- Click {guilabel}`Review` to open a person and 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). +- Click {guilabel}`Approve` or {guilabel}`Decline` for someone waiting. +- Click {guilabel}`Make owner` or {guilabel}`Remove owner` to change their role. +- Click {guilabel}`Remove from hackathon` to remove them. For an owner, remove + the owner role first. diff --git a/docs/src/owner/manage-projects.md b/docs/src/owner/manage-projects.md index eace8e93..621e02d0 100644 --- a/docs/src/owner/manage-projects.md +++ b/docs/src/owner/manage-projects.md @@ -1,5 +1,35 @@ # 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 + +- Click the tabs {guilabel}`Approved`, {guilabel}`Awaiting review` and + {guilabel}`Rejected` to switch between statuses. +- Click {guilabel}`Download CSV` to get all projects as a spreadsheet. +- Click {guilabel}`Review` or {guilabel}`Edit` next to a project. + +## Review + +- Click {guilabel}`Approve` or {guilabel}`Reject`. When you reject, you can give + a reason. {guilabel}`Revoke approval` and {guilabel}`Reconsider` undo a + decision. +- Only approved projects appear on [Projects](../participant/member-projects.md) + and on [Manage Teams](manage-teams.md). + +## New project + +- Click {guilabel}`New Project` to add one. It is the same form participants use + to propose. +- Participants propose only while you allow it, see + [Settings](manage-settings.md). diff --git a/docs/src/owner/manage-public.md b/docs/src/owner/manage-public.md index a1bb3f11..cd72b666 100644 --- a/docs/src/owner/manage-public.md +++ b/docs/src/owner/manage-public.md @@ -1,6 +1,26 @@ # 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 + +- Enter the {guilabel}`Name`, {guilabel}`Starts at`, {guilabel}`Ends at`, + {guilabel}`Logo URL` and {guilabel}`Description`. Choose the + {guilabel}`Visibility`: public or private. +- Private hackathons are reached through [Invitations](manage-invites.md). +- Dates can be changed but not removed once set. +- Click {guilabel}`Save changes` to save and return to + [Settings](manage-settings.md). + +## The preview + +- Updates as you type. diff --git a/docs/src/owner/manage-settings.md b/docs/src/owner/manage-settings.md index 9ff5ebdb..7f87e2c4 100644 --- a/docs/src/owner/manage-settings.md +++ b/docs/src/owner/manage-settings.md @@ -1,6 +1,18 @@ # Settings -Settings is the first page under **Manage Hackathon** in your hackathon's menu. +:::{admonition} Owner's Settings + +The first page under {guilabel}`Manage Hackathon`. It shows: + +- [What participants can do](#what-participants-can-do): the checkboxes that + steer the hackathon +- {guilabel}`Where the hackathon is`: the current and next phase, see + [Manage Timeline](manage-timeline.md) +- {guilabel}`Tracks`: optional, see [Manage Tracks](manage-tracks.md) +- {guilabel}`Manage`: a tile for every other page under + {guilabel}`Manage Hackathon` + +::: ![The Settings page of a hackathon, as its owner sees it](../static/screenshots/manage-settings.png) @@ -18,14 +30,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 checkbox then shows them. You always see the results yourself. See [Results](../participant/member-results.md). | diff --git a/docs/src/owner/manage-submissions.md b/docs/src/owner/manage-submissions.md index 2a13da30..0fb16e1e 100644 --- a/docs/src/owner/manage-submissions.md +++ b/docs/src/owner/manage-submissions.md @@ -1,5 +1,31 @@ # 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 + +- The page says {guilabel}`Submissions are open` or + {guilabel}`Submissions are closed`. Change it on + [Settings](manage-settings.md). + +## Teams + +- Click the tabs {guilabel}`All`, {guilabel}`No submission`, + {guilabel}`Draft only` and {guilabel}`Final` to filter. Search by team, + project or person. +- Click {guilabel}`Download CSV` to get all teams. +- Per team: members, the entry, its version and who submitted it. Earlier + versions are folded away. +- Read-only: teams hand in and finalize themselves on + [Submissions](../participant/member-submissions.md). +- No teams yet: click {guilabel}`Set up teams` to go to + [Manage Teams](manage-teams.md). diff --git a/docs/src/owner/manage-teams.md b/docs/src/owner/manage-teams.md index e2aef5de..e6005a91 100644 --- a/docs/src/owner/manage-teams.md +++ b/docs/src/owner/manage-teams.md @@ -1,5 +1,62 @@ # 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 + {guilabel}`N want in` and its teams. +- Click {guilabel}`+ Add Team` to add a team. You can also rename or delete a + team. +- Drag people between teams. + +## Unassigned + +- Filter by registration answer or preferred project. Click + {guilabel}`Reset filters` to clear them. + +## Filters and cards + +- {guilabel}`Registration questions`: give each question a short name and filter + by its answers. Tick {guilabel}`Show on cards` to show the answers on each + person. See [Manage Forms](manage-forms.md). +- {guilabel}`Project preferences`: what participants chose on + [Projects](../participant/member-projects.md#preferences). +- Enter a name in {guilabel}`Find a person` to search the page. + +## Spreadsheet + +- Click {guilabel}`Download CSV` to get everyone with their preferences and + answers. +- Edit the `project` and `team` columns, then click {guilabel}`Upload CSV`. It + replaces all teams. +- Click {guilabel}`How assignment works` for the format. + +## Saving + +- Nothing is stored until you click {guilabel}`Save`. Click {guilabel}`Discard` + to drop 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. diff --git a/docs/src/owner/manage-timeline.md b/docs/src/owner/manage-timeline.md index d865c637..c46b22e9 100644 --- a/docs/src/owner/manage-timeline.md +++ b/docs/src/owner/manage-timeline.md @@ -1,6 +1,13 @@ # Manage Timeline -Adding, editing and removing phases. It appears once the hackathon has a phase. +:::{admonition} Owner's Manage Timeline + +The hackathon's phases. Appears once the hackathon has a phase. It shows: + +- [Phases](#phases): each phase with its dates and status +- [A phase](#a-phase): add, edit or delete one + +::: ![The Manage Timeline page of a hackathon, as its owner sees it](../static/screenshots/manage-timeline.png) @@ -11,6 +18,18 @@ participants can do. That is decided on [Settings](manage-settings.md). ::: -Phases show participants where the hackathon stands. Each has a title, a -description, and a start and an end time. Participants see them on the -[Timeline](../participant/member-timeline.md). +## Phases + +- Status per phase: {guilabel}`Completed`, {guilabel}`In progress`, + {guilabel}`Upcoming` or {guilabel}`Current phase`. +- Click {guilabel}`Make current` or {guilabel}`Clear current phase` to move the + marker. You can also move it on [Settings](manage-settings.md). +- Participants see the phases on [Timeline](../participant/member-timeline.md). + +## A phase + +- Click {guilabel}`Add phase` and enter a name and description. Add its dates + afterwards. +- Enter both {guilabel}`Starts` and {guilabel}`Ends`, or neither. Once set, they + can be changed but not removed. +- Click {guilabel}`Delete this phase` to remove it. diff --git a/docs/src/owner/manage-tracks.md b/docs/src/owner/manage-tracks.md index 9f04dbbd..77a27774 100644 --- a/docs/src/owner/manage-tracks.md +++ b/docs/src/owner/manage-tracks.md @@ -1,15 +1,31 @@ # Manage Tracks -Adding, changing and removing tracks. It appears once the hackathon has a track. +:::{admonition} Owner's Manage Tracks + +The hackathon's tracks. Appears once the hackathon has a track. It shows: + +- [Tracks](#tracks): each track with its description +- [A track](#a-track): add, edit or delete one + +::: ![The Manage Tracks page of a hackathon, as its owner sees it](../static/screenshots/manage-tracks.png) :::{admonition} Tracks are optional -Hackathons without tracks are perfectly fine. +Hackathons without tracks are perfectly fine. Add the first one on +[Settings](manage-settings.md). ::: -Tracks group projects, for example by theme. Once a hackathon has a track, -**Manage Tracks** appears in the menu, where you add tracks and edit their -descriptions. +## Tracks + +- Tracks group projects, for example by theme. +- A project picks its track when it is proposed or edited, see + [Manage Projects](manage-projects.md). + +## A track + +- Click {guilabel}`New track` and enter a name and description. +- Click {guilabel}`Delete this track` to remove it. Its projects stay, without a + track. diff --git a/docs/src/owner/manage-voting.md b/docs/src/owner/manage-voting.md index 2cf35650..a07a21df 100644 --- a/docs/src/owner/manage-voting.md +++ b/docs/src/owner/manage-voting.md @@ -1,5 +1,46 @@ # Manage Voting -Vote categories, who votes in them, and the results. +:::{admonition} Owner's Manage Voting + +Vote categories and results. It shows: + +- [How voting works](#how-voting-works): the four steps and where each stands +- [Categories](#categories): what participants vote on +- [Count so far](#count-so-far): the live tally, for owners only + +It might also show: + +- [Final results](#final-results): once you make the results final + +::: ![The Manage Voting page of a hackathon, as its owner sees it](../static/screenshots/manage-voting.png) + +## How voting works + +1. Set up the categories. +2. Open voting, then close it: tick, then untick + {guilabel}`Participants can vote` on [Settings](manage-settings.md). +3. Make the results final, here. +4. Publish them: tick {guilabel}`Publish results` on + [Settings](manage-settings.md). + +## Categories + +- Click {guilabel}`New category` and enter a name and description. Choose how + people vote: {guilabel}`Single choice` (pick one) or {guilabel}`Points` + (spread a budget, 10 by default). +- Click {guilabel}`Edit` or {guilabel}`Delete` to change or remove a category, + until someone has voted in it. Then it is {guilabel}`Locked`. +- Participants vote on [Voting](../participant/member-voting.md). + +## Count so far + +- The ranking per category as votes come in. Participants don't see it. +- Click {guilabel}`Make results final` once voting is closed. It cannot be + undone. + +## Final results + +- Participants see them on [Results](../participant/member-results.md) once you + publish them. diff --git a/docs/src/participant/member-overview.md b/docs/src/participant/member-overview.md index 23b63b7b..ae2b5d3b 100644 --- a/docs/src/participant/member-overview.md +++ b/docs/src/participant/member-overview.md @@ -1,6 +1,56 @@ # Overview -The first page of a hackathon: its dates, the phase it is in, what you can do -right now, and your team. +:::{admonition} Participant's Overview + +The first page of a hackathon. It shows: + +- [Your hackathon](#your-hackathon): its dates and number of participants +- [What you can do](#what-you-can-do): links to everything that is open now +- [Your team](#your-team): your team, or how to find one + +It might also show: + +- [The current phase](#the-current-phase): if the hackathon has phases +- [Projects](#projects): once projects are approved +- [About this hackathon](#about-this-hackathon): if the owners wrote a + description + +::: ![The Overview page of a hackathon, as a participant sees it](../static/screenshots/member-overview.png) + +## Your hackathon + +- Start and end date, and how many participants it has. + +## What you can do + +- One link per activity the owners have opened: + [propose projects](member-projects.md#propose-a-project), + [choose preferred projects](member-projects.md#preferences), + [see teams](member-teams.md), [submit work](member-submissions.md), + [vote](member-voting.md), [see results](member-results.md). +- "Nothing is open right now" when the owners have opened nothing. +- On the waitlist the links stay closed until an owner approves you. + +## The current phase + +- Name, dates, countdown and description of the phase that is running. +- Phases are for orientation only, see [Timeline](member-timeline.md). + +## Your team + +- Your team's members, its project and whether it has handed in work. +- Click {guilabel}`Submit your work` to go to + [Submissions](member-submissions.md) while submitting is open. +- Not on a team yet: click {guilabel}`Browse the projects` to go to + [Projects](member-projects.md). + +## Projects + +- The number of approved projects, per track if there are tracks. +- Click {guilabel}`View all` to go to [Projects](member-projects.md). + +## About this hackathon + +- The hackathon's description. diff --git a/docs/src/participant/member-participants.md b/docs/src/participant/member-participants.md index 1a17fcc3..24b57f63 100644 --- a/docs/src/participant/member-participants.md +++ b/docs/src/participant/member-participants.md @@ -1,5 +1,33 @@ # Participants -Everyone taking part in the hackathon, with your own entry at the top. +:::{admonition} Participant's Participants + +Everyone taking part in the hackathon. It shows: + +- [All participants](#all-participants): with search, your own entry first +- [A participant's profile](#a-participants-profile): links, shared answers and + teams + +::: ![The Participants page of a hackathon, as a participant sees it](../static/screenshots/member-participants.png) + +## All participants + +- Search by name or role. +- Your own entry is at the top, marked {guilabel}`You`. +- Click {guilabel}`View` to open a profile. On your own entry the button reads + {guilabel}`View & edit`. + +## A participant's profile + +- Name, profile links and the date they joined. +- {guilabel}`Shared answers`: the registration answers they chose to share. +- {guilabel}`Teams`: their teams, once teams are published. Each links to its + [team](member-teams.md). + +On your own profile: + +- Click {guilabel}`Edit answers` to change your registration answers. +- Click {guilabel}`Add your GitHub, LinkedIn or Renku link` to go to your + account page. diff --git a/docs/src/participant/member-projects.md b/docs/src/participant/member-projects.md index f5d041ea..ff96d12d 100644 --- a/docs/src/participant/member-projects.md +++ b/docs/src/participant/member-projects.md @@ -1,6 +1,42 @@ # Projects -The hackathon's projects, and, while proposing is open, where you propose your -own. +:::{admonition} Participant's Projects + +The projects you can work on. It shows: + +- [Approved projects](#approved-projects): the projects of this hackathon + +It might also show: + +- [Propose a project](#propose-a-project): while the owners take proposals +- [Your proposals](#your-proposals): your proposals that are not approved yet +- [Preferences](#preferences): while the owners collect project preferences + +::: ![The Projects page of a hackathon, as a participant sees it](../static/screenshots/member-projects.png) + +## Approved projects + +- Eight projects per page. Each opens its details: description, track and who + proposed it. + +## Propose a project + +- Click {guilabel}`Propose a Project`, then enter a title, a description, and a + track if the hackathon has tracks. +- An owner reviews it before it appears in the list, see + [Manage Projects](../owner/manage-projects.md). + +## Your proposals + +- Each with its status, for example {guilabel}`Rejected`, and the owner's + reason. +- Click {guilabel}`Edit` to change it while it is still waiting for review. + +## Preferences + +- Click {guilabel}`Prefer` to mark a project you would like to work on. + {guilabel}`★ Preferred` shows you did. +- The owners use the preferences to form the teams, see + [Manage Teams](../owner/manage-teams.md). diff --git a/docs/src/participant/member-results.md b/docs/src/participant/member-results.md index c6dec1f4..1ae1e4f6 100644 --- a/docs/src/participant/member-results.md +++ b/docs/src/participant/member-results.md @@ -1,5 +1,23 @@ # Results -The vote results. It appears once the owners let participants see them. +:::{admonition} Participant's Results + +The outcome of the voting. Appears once the owners publish the results. It +shows: + +- [Placings](#placings): per vote category +- [All entries](#all-entries): every team that entered + +::: ![The Results page of a hackathon, as a participant sees it](../static/screenshots/member-results.png) + +## Placings + +- Per category: the placed entries with medal and score. +- Click {guilabel}`View entry` to open the [team](member-teams.md) and its + entry. + +## All entries + +- Every team that entered. Yours is marked {guilabel}`Your team`. diff --git a/docs/src/participant/member-submissions.md b/docs/src/participant/member-submissions.md index c9149e2a..d18eb863 100644 --- a/docs/src/participant/member-submissions.md +++ b/docs/src/participant/member-submissions.md @@ -1,5 +1,32 @@ # Submissions -Where your team hands in its work. +:::{admonition} Participant's Submissions + +Where your team hands in its work. It shows, for each of your teams: + +- [Hand in work](#hand-in-work): save a draft +- [Finalize](#finalize): make a version your team's entry +- [Earlier versions](#earlier-versions): everything handed in so far + +::: ![The Submissions page of a hackathon, as a participant sees it](../static/screenshots/member-submissions.png) + +## Hand in work + +- You can hand in work once you are on a [team](member-teams.md), and only while + submitting is open. The [Overview](member-overview.md) shows whether it is. +- Enter a link or notes, then click {guilabel}`Save draft`. Every draft is a new + version. + +## Finalize + +- Click {guilabel}`Finalize this version` to make a draft your team's entry. +- Anyone on the team can do it, and it cannot be undone. +- You can finalize a newer draft later. The latest final version is your team's + entry. +- The entry is what others [vote](member-voting.md) on. + +## Earlier versions + +- All versions your team handed in, folded away. Click them to unfold. diff --git a/docs/src/participant/member-teams.md b/docs/src/participant/member-teams.md index 406e2d76..ba40d70e 100644 --- a/docs/src/participant/member-teams.md +++ b/docs/src/participant/member-teams.md @@ -1,6 +1,26 @@ # Teams -The teams and who is on them. It appears once there are teams and the owners let -participants see them. +:::{admonition} Participant's Teams + +Who works on which project. Appears once teams exist and the owners publish +them. It shows: + +- [All teams](#all-teams): grouped by project +- [A team](#a-team): its members, its project and its final entry + +::: ![The Teams page of a hackathon, as a participant sees it](../static/screenshots/member-teams.png) + +## All teams + +- Teams grouped under their project. The project title links to its + [project](member-projects.md). +- Each team shows its members and its final entry, if it has one. +- Click {guilabel}`View` to open [a team](#a-team). + +## A team + +- Its members, and its project with the full proposal. +- Its final entry, or a note that it has none yet. +- Hand in your own team's work on [Submissions](member-submissions.md). diff --git a/docs/src/participant/member-timeline.md b/docs/src/participant/member-timeline.md index 588d7b3a..ca8de18c 100644 --- a/docs/src/participant/member-timeline.md +++ b/docs/src/participant/member-timeline.md @@ -1,6 +1,27 @@ # Timeline -The hackathon's phases with their dates, and which one is running now. It -appears once the hackathon has a phase. +:::{admonition} Participant's Timeline + +A hackathon can have phases, which show what happens when. This page appears +only if it has some. It shows: + +- [Phases](#phases): every phase with its dates + +It might also show: + +- [The current phase](#the-current-phase): while a phase is running, with what + is open now + +::: ![The Timeline page of a hackathon, as a participant sees it](../static/screenshots/member-timeline.png) + +## Phases + +- Every phase with its start and end date. The next one has a countdown. +- Phases don't open or close anything. The owners do that separately. + +## The current phase + +- Its dates, a countdown, its description and what is open now. +- Click {guilabel}`See the details` to go to the [Overview](member-overview.md). diff --git a/docs/src/participant/member-voting.md b/docs/src/participant/member-voting.md index 7bf21bb6..ed12cc12 100644 --- a/docs/src/participant/member-voting.md +++ b/docs/src/participant/member-voting.md @@ -1,5 +1,23 @@ # Voting -Where you cast your votes. It appears while the owners have voting switched on. +:::{admonition} Participant's Voting + +Where you vote on the teams' final entries. Appears while the owners have voting +open. It shows: + +- [Categories](#categories): one ballot per category + +::: ![The Voting page of a hackathon, as a participant sees it](../static/screenshots/member-voting.png) + +## Categories + +- You vote once in each category, and your vote is final. +- {guilabel}`Single choice`: pick one entry. {guilabel}`Points`: spread your + points across entries. +- Your own team is not on the ballot. +- Click {guilabel}`View entry` to open a [team](member-teams.md) and its entry. + Votes you have not submitted yet are lost. +- After voting the card shows what you chose. Results come later on + [Results](member-results.md).