mirror of
https://github.com/lukevella/rallly.git
synced 2025-05-24 14:26:23 +02:00
📝 Update docs
This commit is contained in:
Luke Vella
parent
7cbf14127a
commit
ac403d1f99
26 changed files with 111 additions and 122 deletions
50
apps/docs/administrators/creating-a-meeting-poll.mdx
Normal file
50
apps/docs/administrators/creating-a-meeting-poll.mdx
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: "Creating a Meeting Poll"
|
||||
description: "Learn how to create a meeting poll with Rallly."
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
Meeting polls allow participants to vote for their preferred dates so that you can find the best date for your meeting.
|
||||
|
||||
## Get started
|
||||
|
||||
To create a meeting poll, start by going to the [New Meeting Poll Page](https://rallly.co/new).
|
||||
|
||||
## 1. Enter the meeting details
|
||||
|
||||
Enter a meaningful title for your participants to see.
|
||||
You can also add a description to give more context to your poll and a location if desired.
|
||||
|
||||
<Frame></Frame>
|
||||
|
||||
Click **Continue** to proceed.
|
||||
|
||||
## 2. Choose date options
|
||||
|
||||
Use the date picker to select the dates you want to offer your participants.
|
||||
After selecting your dates, you can also add a time range by switching on **Specify times**.
|
||||
|
||||
<Frame></Frame>
|
||||
|
||||
<Accordian title="How do I manage timezones?">
|
||||
If you do not choose to specify times Rallly will not associate a timezone with your selected dates to ensure
|
||||
all participants will see the same dates regardless of their timezone.
|
||||
|
||||
If you do choose to specify times, Rallly will associate the timezone of your browser with the selected dates by default
|
||||
and participants will see times adjusted to their timezone when they vote. This behaviour is ideal for remote meetings where
|
||||
participants can be in different timezones.
|
||||
|
||||
If all participants are in the same timezone or the event is happening at a physical location, you can change the timezone to **Ignore timezone**
|
||||
to ensure that everyone will see the same times.
|
||||
|
||||
</Accordian>
|
||||
|
||||
If you're **logged in** you can click **Create poll** to create the poll.
|
||||
|
||||
If you're **not logged in**, can click **Continue** to proceed to the next step.
|
||||
|
||||
## 3. Enter your details (Guest's only)
|
||||
|
||||
Enter your name and email address.
|
||||
These will only be used to email the link to the meeting poll to you and ensure you won't lose access to your poll.
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: "Creating a meeting poll"
|
||||
description: "Meeting polls allow participants to vote for their preferred dates."
|
||||
---
|
||||
|
||||
## Get started
|
||||
|
||||
To create a meeting poll, start by going to the [New Meeting Poll Page](https://rallly.co/new).
|
||||
|
||||
## 1. Enter the meeting details
|
||||
|
||||
Enter a meaningful title for your participants to see.
|
||||
You can also add a description to give more context to your poll and a location if desired.
|
||||
|
||||
<Frame></Frame>
|
||||
|
||||
Click **Continue** to proceed.
|
||||
|
||||
## 2. Choose date options
|
||||
|
||||
Use the date picker to select the dates you want to offer your participants.
|
||||
After selecting your dates, you can also add a time range by switching on **Specify times**.
|
||||
|
||||
<Frame></Frame>
|
||||
|
||||
If you're **logged in** you can click **Create poll** to create the poll.
|
||||
|
||||
If you're **not logged in**, can click **Continue** to proceed to the next step.
|
||||
|
||||
## 3. Enter your details (Guest's only)
|
||||
|
||||
Enter your name and email address.
|
||||
These will only be used to email the link to the meeting poll to you and ensure you won't lose access to your poll.
|
||||
15
apps/docs/administrators/deleting-a-meeting-poll.mdx
Normal file
15
apps/docs/administrators/deleting-a-meeting-poll.mdx
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Deleting a Meeting Poll"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Deleting a poll will delete all data related to that poll such as options,
|
||||
participants and votes. This action cannot be undone.
|
||||
</Warning>
|
||||
|
||||
To delete a meeting poll, from the admin page:
|
||||
|
||||
1. Click **Manage**
|
||||
1. Select **Delete poll** from the dropdown menu
|
||||
1. Enter the confirmation text in the input
|
||||
1. Click **Delete poll**
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
---
|
||||
title: "Deleting a meeting poll"
|
||||
description:
|
||||
"Deleting a poll is an irreversible action. There is no way to restore a
|
||||
deleted poll."
|
||||
---
|
||||
|
||||
- Go to **Manage > Delete poll**
|
||||
- Enter the confirmation text in the input
|
||||
- Click **Delete poll**
|
||||
|
||||
Deleting a poll will delete all data related to that poll such as options,
|
||||
participants and votes.
|
||||
|
|
@ -1,13 +1,12 @@
|
|||
---
|
||||
title: "Editing a meeting poll"
|
||||
title: "Editing a Meeting Poll"
|
||||
description: "How to make changes to an existing meeting poll."
|
||||
---
|
||||
|
||||
First, make sure you have access to the
|
||||
[admin page](/administrators/accessing-the-admin-page) of your poll. From here
|
||||
you can access the **Manage** menu.
|
||||
From the admin page, click on **Manage** to open the dropdown menu.
|
||||
|
||||
<Frame caption="Admin controls">
|
||||
|
||||
|
||||
</Frame>
|
||||
|
||||
## Changing the title, description or location
|
||||
|
|
@ -17,7 +16,7 @@ To change these details of your poll:
|
|||
1. Click **Manage**
|
||||
2. Select **Edit details** from the dropdown menu
|
||||
|
||||
<Frame></Frame>
|
||||
<Frame></Frame>
|
||||
|
||||
3. Enter the new details of your poll in to the form and click **Save**.
|
||||
|
||||
|
|
@ -27,7 +26,7 @@ To change these details of your poll:
|
|||
2. Select **Edit options** from the dropdown menu
|
||||
|
||||
<Frame caption="Date or time picker">
|
||||
|
||||
|
||||
</Frame>
|
||||
|
||||
3. Add/remove options using the date/time picker
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: "Sharing a meeting poll"
|
||||
title: "Sharing a Meeting Poll"
|
||||
description: "How to share a meeting poll with participants."
|
||||
---
|
||||
|
||||
|
|
@ -13,4 +13,4 @@ To share your poll with participants, from the admin page:
|
|||
this link and send it to your participants via email or whichever way you
|
||||
prefer to communicate with your participants.
|
||||
|
||||
<Frame></Frame>
|
||||
<Frame></Frame>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 8.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 125 KiB After Width: | Height: | Size: 125 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 3.8 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Get started"
|
||||
description: "Welcome to the official documentation for Rallly"
|
||||
title: "Support"
|
||||
description: "Welcome to the official documentation for Rallly."
|
||||
---
|
||||
|
||||
## What is Rallly?
|
||||
|
|
@ -18,10 +18,10 @@ from and then tally the results to find the best time.
|
|||
## Guides
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Quick start" icon="note" href="/administrator/creating-a-poll">
|
||||
<Card title="Quick start" icon="note" href="/meeting-poll/creating-a-poll">
|
||||
Get started by learning how to create a new meeting poll.
|
||||
</Card>
|
||||
<Card title="Self-Hosting" icon="server" href="/">
|
||||
<Card title="Self-Hosting" icon="server" href="/self-hosting">
|
||||
Learn how to run your own instance of Rallly on your own server.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
|
@ -40,20 +40,16 @@
|
|||
],
|
||||
"navigation": [
|
||||
{
|
||||
"group": "Introduction",
|
||||
"pages": ["get-started"]
|
||||
},
|
||||
{
|
||||
"group": "For Administrators",
|
||||
"group": "Guides for Administrators",
|
||||
"pages": [
|
||||
"administrators/creating-a-poll",
|
||||
"administrators/sharing-a-poll",
|
||||
"administrators/editing-a-poll",
|
||||
"administrators/deleting-a-poll"
|
||||
"administrators/creating-a-meeting-poll",
|
||||
"administrators/sharing-a-meeting-poll",
|
||||
"administrators/editing-a-meeting-poll",
|
||||
"administrators/deleting-a-meeting-poll"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "For Participants",
|
||||
"group": "Guides for Participants",
|
||||
"pages": [
|
||||
"participants/submitting-a-response",
|
||||
"participants/editing-a-response"
|
||||
|
|
@ -62,7 +58,7 @@
|
|||
{
|
||||
"group": "Self-Hosting",
|
||||
"pages": [
|
||||
"self-hosting/getting-started",
|
||||
"self-hosting/introduction",
|
||||
"self-hosting/managed-hosting",
|
||||
"self-hosting/configuration-options"
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
title: "Editing a response"
|
||||
title: "Editing a Response"
|
||||
description:
|
||||
"As a participant, you are only allowed to edit your own response. Your
|
||||
response will have a badge labelled 'You' next to the name."
|
||||
---
|
||||
|
||||
<Frame caption="The 'You' badge indicates that this is your response">
|
||||
|
||||
|
||||
</Frame>
|
||||
|
||||
If you see your response but it doesn't habe this badge, it means we can't tell
|
||||
|
|
@ -24,7 +24,7 @@ will allow you to edit your response from anywhere.
|
|||
<Tab title="On Desktop">
|
||||
|
||||
<Frame caption="Click the 'Edit votes' menu item to begin editing">
|
||||
|
||||
|
||||
</Frame>
|
||||
|
||||
1. Click the 3 dots icon to open up the dropdown menu.
|
||||
|
|
@ -37,7 +37,7 @@ will allow you to edit your response from anywhere.
|
|||
<Tab title="On Mobile">
|
||||
|
||||
<Frame caption="Click the 'Edit votes' menu item to begin editing">
|
||||
|
||||
|
||||
</Frame>
|
||||
|
||||
1. Select your name in the list of participants.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: "Submitting a response"
|
||||
title: "Submitting a Response"
|
||||
description: "To respond to a poll, start by clicking the buttons under the
|
||||
corresponding dates to set your availability."
|
||||
---
|
||||
|
|
@ -8,13 +8,13 @@ description: "To respond to a poll, start by clicking the buttons under the
|
|||
- If need be (2 clicks)
|
||||
- No (3 clicks or leave blank)
|
||||
|
||||
<Frame></Frame>
|
||||
<Frame></Frame>
|
||||
|
||||
Once you've set your availability click **Continue** to bring up the **New
|
||||
Participant** dialog.
|
||||
|
||||
<Frame caption="The New Pariticpant Dialog">
|
||||
|
||||
|
||||
</Frame>
|
||||
|
||||
Enter your name and your email address in to the form and click **Submit**.
|
||||
|
|
|
|||
|
|
@ -1,49 +1,24 @@
|
|||
---
|
||||
title: Configuration options
|
||||
description: Learn how to configure Rallly with environment variables.
|
||||
title: Configuration Options
|
||||
description: Using environment variable to configure a self-hosted instance of Rallly.
|
||||
---
|
||||
|
||||
## Environment variables
|
||||
|
||||
Rallly can be configured with the following environment variables.
|
||||
|
||||
### Required config
|
||||
|
||||
These variables are required for Rallly to function properly.
|
||||
|
||||
| Name | Default | Description |
|
||||
| ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `NEXT_PUBLIC_BASE_URL` | http://localhost:3000 | The base url where this instance is accessible, including the scheme (eg. `http://` or `https://`), the domain name, and optionally a port. |
|
||||
| `SECRET_PASSWORD` | | A random 32-character secret key used to encrypt user sessions |
|
||||
|
||||
### Email config
|
||||
|
||||
Configure the following variables to give Rallly the ability to send emails.
|
||||
|
||||
| Name | Default | Description |
|
||||
| ------------------ | --------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `SUPPORT_EMAIL` | | All outgoing emails will show this email as the sender's email address, which also serves as the support email. |
|
||||
| `SMTP_HOST` | localhost | The host address of your SMTP server |
|
||||
| `SMTP_PORT` | 25 or 465 | The port of your SMTP server |
|
||||
| `SMTP_SECURE` | false | Set to "true" if SSL is enabled for your SMTP connection |
|
||||
| `SMTP_USER` | | The username (if auth is enabled on your SMTP server) |
|
||||
| `SMTP_PWD` | | The password (if auth is enabled on your SMTP server) |
|
||||
| `SMTP_TLS_ENABLED` | false | Enable TLS for your SMTP connection |
|
||||
|
||||
### Optional config (recommended)
|
||||
|
||||
Adjust your instance and protect it from unauthorized users.
|
||||
|
||||
| Name | Default | Description |
|
||||
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `AUTH_REQUIRED` | false | Set to `true` to require authentication for creating new polls and accessing admin pages |
|
||||
| `ALLOWED_EMAILS` | | Comma separated list of email addresses that are allowed to register and login. Wildcard characters are supported. Example: `*@yourcompany.com` |
|
||||
| `DISABLE_LANDING_PAGE` | false | Whether or not to disable the landing page |
|
||||
|
||||
### Advanced config
|
||||
|
||||
In most cases you won't need to set this yourself.
|
||||
|
||||
| Name | Default | Description |
|
||||
| -------------- | ------- | ----------------------------------- |
|
||||
| `DATABASE_URL` | | Postgres database connection string |
|
||||
| Environment Variable | Default | Description |
|
||||
| ---------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ALLOWED_EMAILS` | | Comma separated list of email addresses that are allowed to register and login. Wildcard characters are supported. Example: `*@yourcompany.com` |
|
||||
| `AUTH_REQUIRED` | false | Set to `true` to require authentication for creating new polls and accessing admin pages |
|
||||
| `DATABASE_URL` | | Postgres database connection string |
|
||||
| `DISABLE_LANDING_PAGE` | false | Whether or not to disable the landing page |
|
||||
| `NEXT_PUBLIC_BASE_URL` | http://localhost:3000 | The base url where this instance is accessible, including the scheme (eg. `http://` or `https://`), the domain name, and optionally a port. |
|
||||
| `SECRET_PASSWORD` | | A random 32-character secret key used to encrypt user sessions |
|
||||
| `SMTP_HOST` | localhost | The host address of your SMTP server |
|
||||
| `SMTP_PORT` | 25 or 465 | The port of your SMTP server |
|
||||
| `SMTP_SECURE` | false | Set to "true" if SSL is enabled for your SMTP connection |
|
||||
| `SMTP_USER` | | The username (if auth is enabled on your SMTP server) |
|
||||
| `SMTP_PWD` | | The password (if auth is enabled on your SMTP server) |
|
||||
| `SMTP_TLS_ENABLED` | false | Enable TLS for your SMTP connection |
|
||||
| `SUPPORT_EMAIL` | | All outgoing emails will show this email as the sender's email address, which also serves as the support email. |
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
title: Self-Hosting Rallly
|
||||
title: Introduction
|
||||
description: How to run your own instance of Rallly.
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
## Get Started
|
||||
|
||||
Depending on how comfortable you are with technical things, you can either run Rallly on your own server or choose a provider that will do it for you.
|
||||
Depending on how comfortable you are with technical things, you can either run Rallly on your own server or choose a managed hosting provider that will do it for you.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
Loading…
Add table
Add a link
Reference in a new issue