Skip to content

Commit

Permalink
enhancements to layout
Browse files Browse the repository at this point in the history
  • Loading branch information
@pholm
pholm committed Jun 8, 2021
1 parent da35359 commit feeb0e4
Showing 1 changed file with 126 additions and 106 deletions.
232 changes: 126 additions & 106 deletions DOCUMENTATION.md
View file
Original file line number Diff line number Diff line change
@@ -1,54 +1,93 @@
<!-- TOC ignore:true -->

# Junction App event organizer guidebook

This is a work-in-progress documentation on how to use Junction App. This guidebook is open-source and we hope that you comment and create additions to the content here.

**Table of contents**

<!-- TOC -->

- [Junction App event organizer guidebook](#junction-app-event-organizer-guidebook)
- [Creating an event](#creating-an-event)
- [Managing an event](#managing-an-event)
- [Editing an event](#editing-an-event)
- [Basic info](#basic-info)
- [Configuration](#configuration)
- [Schedule](#schedule)
- [Questions](#questions)
- [Stats](#stats)
- [Participants](#participants)
- [Project](#project)
- [Results](#results)
- [Check-in](#check-in)
- [Travel grants](#travel-grants)
- [Manage](#manage)

<!-- /TOC -->

# Terminology

In Junction App, there are a lot of different stakeholders with different permissions and roles in the event.

- Participant
- Partner
- Organizer
- Team
-

# Creating an event

Sign in to your account → choose the three horizontal line → Create event

Create a new event → write your event’s name and click on Create

# Manage event
# Managing an event

Sign in to your account → choose the three horizontal line → Create event (see above)
Sign in to your account → choose the hamburger menu on top → Create event
Choose the event at “Your events” → Manage
Now you can see the event’s editorial page

# Edit event

## Basic info:

Cover image: uploading cover image
Event logo: uploading a logo for the event
Event name
Description: here you can put links, pictures and shape your text
Organizations organizing the event: adding other organizers
Link to challenge descriptions (URL link)_
FAQ link (URL link)_
Demo instruction link (URL link)_
Privacy Policy for this event (URL link)_
Terms and Conditions for this event (URL link)*
Event page customization: customizing the colors for your event page (header, side and sidebar background, text color)
*these are shown at the end of the signup process

## Configuration:

Published: as soon as you finalized your event you can switch to “Yes”
Additional important information here: The event needs to be approved by the administration before it's public. It can be set published, but it will be pending until that happens.
Project Gallery open: Yes / No - as soon as the projects have been uploaded, switch to “Yes”
Projects submitted per challenge: basically “No” - if we want that one team can only submit only one project for a challenge they chose during the event (if we want them to submit many projects then switch to “Yes”)
Event type: online / offline
Does this event have multiple tracks?: depends on event, if “Yes”, you can give the different Tracks
Does this event have multiple challenges?: usually “Yes”, as soon as you have the final challenges switch to “Yes” and then you must give basic informations for the challenge (Name - Unique slug - Partner name)
Reviewing method:
Gavel, peer-reviewing: teams can evaluate each other with the help of the Gavel algorithm which gives a weighted average at the end. If the event has no tracks, then all participants evaluate each other. If there are tracks, evaluation is within a track. Basically: teams may review other teams from the same track and from the same challenge!
Manual review: ...
Overall winner method
Finals, public voting:
Finals, manual selection: organizers can choose teams who will go to the finals
Projects → choose the project, click on it → “Does this project go to finals!” check the box

No overall winner: -
Allow vote on own projects: “Yes / No” - usually no, since we don’t want them to vote on their on projects
Is finalist voting open: “Yes” / “No” -

## Schedule:
# Editing an event

## Basic info

- Cover image: uploading cover image
- Event logo: uploading a logo for the event
- Event name
- Description: here you can put links, pictures and shape your text
- Organizations organizing the event: adding other organizers
- Link to challenge descriptions (URL link)
- FAQ link (URL link)
- Demo instruction link (URL link)
- Privacy Policy for this event (URL link)
- Terms and Conditions for this event (URL link)\*
- Event page customization: customizing the colors for your event page (header, side and sidebar background, text color)

_\*these are shown at the end of the signup process_

## Configuration

- Published: as soon as you finalized your event you can switch to “Yes”
- Additional important information here: The event needs to be approved by the administration before it's public. It can be set published, but it will be pending until that happens.
- Project Gallery open: Yes / No - as soon as the projects have been uploaded, switch to “Yes”
- Projects submitted per challenge: basically “No” - if we want that one team can only submit only one project for a challenge they chose during the event (if we want them to submit many projects then switch to “Yes”)
Event type: online / offline
- Does this event have multiple tracks?: depends on event, if “Yes”, you can give the different Tracks
- Does this event have multiple challenges?: usually “Yes”, as soon as you have the final challenges switch to “Yes” and then you must give basic informations for the challenge (Name - Unique slug - Partner name)
- Reviewing method:
Gavel, peer-reviewing: teams can evaluate each other with the help of the Gavel algorithm which gives a weighted average at the end. If the event has no tracks, then all participants evaluate each other. If there are tracks, evaluation is within a track. Basically: teams may review other teams from the same track and from the same challenge!
Manual review: ...
Overall winner method
- Finals, public voting:
Finals, manual selection: organizers can choose teams who will go to the finals
Projects → choose the project, click on it → “Does this project go to finals!” check the box

- No overall winner:
- Allow vote on own projects: “Yes / No” - usually no, since we don’t want them to vote on their on projects
- Is finalist voting open: “Yes” / “No” -

## Schedule

- Timezone: choose according to your city
- Dates you must set up:
Expand All @@ -57,71 +96,52 @@ Is finalist voting open: “Yes” / “No” -
.._ start and end of project submission
.._ start and end of reviewing

## Questions:

whites can not be seen, green is optional and red is required
suggested required questions:
First name
Last name
Email
Date of birth
Country of residence
Education
Applying as a team?
Custom question: How did you hear about us? - answer options: FB, instagram, friends, newsletter, etc.
suggested optional questions:
Nationality
Skills
LinkedIn profile
Job opportunities
Submission form
you can write here placeholder messages for Demo name, Demo hint etc.
Miscellaneous
you can give here tags, webhooks, meta tags

## STATS

under construction

## PARTICIPANTS

Participants: you can check your registered participants and their status (Incomplete / Checked-in / No-show), and send them emails or download a list of them
For downloading: check the box in the darker green strip, then you will see a lighter green strip where you can choose what you’d like to do (Email all / Edit all / Export registrations / Export selected)
Teams: you can check the registered teams and according to the method mentioned above you can also export them
Assigned to you: Organizers can assign applications within their team for other team members to evaluate. It can be very practical if you have many people going through eg. hundreds of applications.
Travel: relevant at offline events
Admin & tools: statistics regarding to the registrations

## PROJECT

All projects: all projects in one place, check the box in the green strip and you can download them
By challenge: projects by challenges, here you can generate a link for a challenge’s projects by choosing the challenge and then you will see this blue box → “Generate partner link”
Gavel voting: here you can see the results of the gavel voting
Gavel annotators: under construction
Winners: you will see those teams here that you selected when you adjusted the overall winner method to manual selection

# RESULTS

Overview:
Overall results: redirect to the “Overall” section
Track results: redirect to the “Track” section (only if you have tracks)
Challenge results: redirect to the “Challenges” section
Overall:
you can put all projects in order
if you have tracks than select only the TOP 3 project
Challenges:
you can put projects in order by challenges
you can select the first, second, third etc. places (choose the challenge on the left side and then pull up projects from below)

## CHECK-IN

only for offline events

## TRAVEL GRANTS

only for offline events

## MANAGE
## Questions

Here you can configure the questions to be included in the application form.

Red ones are required, green are optional and white ones are hidden.

## Stats

This feature is currently under construction. If you need detailed information dumps from the database, please contact hello@hackjunction.com.

## Participants

- Participants: you can check your registered participants and their status (Incomplete / Checked-in / No-show), and send them emails or download a list of them.
- Teams: you can check the registered teams and according to the method mentioned above you can also export them

- Assigned to you: Organizers can assign applications within their team for other team members to evaluate. It can be very practical if you have many people going through eg. hundreds of applications.

- Travel: relevant at offline events. Handle travel grants and other practicalities for the participants.
- Admin & tools: statistics regarding the registrations

## Project

- All projects: all projects in one place, check the box in the green strip and you can download them
- By challenge: projects by challenges, here you can generate a link for a challenge’s projects by choosing the challenge and then you will see this blue box → “Generate partner link”
- Gavel voting: here you can see the results of the gavel voting
- Gavel annotators: under construction
- Winners: you will see those teams here that you selected when you adjusted the overall winner method to manual selection

# Results

- Overview:
- Overall results: redirect to the “Overall” section
- Track results: redirect to the “Track” section (only if you have tracks)
- Challenge results: redirect to the “Challenges” section
- Overall: you can put all projects in order if you have tracks than select only the TOP 3 project
- Challenges: you can put projects in order by challenges you can select the first, second, third etc. places (choose the challenge on the left side and then pull up projects from below)

## Check-in

_only for offline events_

## Travel grants

_only for offline events_

## Manage

Organisers: adding and removing organisers
Adding someone as an organiser: click on “Add organisers” and give the exact email address of the person (pay attention ‘cause you’ll get many options so select the proper one carefully)
Expand Down

0 comments on commit feeb0e4

Please sign in to comment.