diff --git a/apps/docs/administrators/creating-a-meeting-poll.mdx b/apps/docs/administrators/creating-a-meeting-poll.mdx new file mode 100644 index 000000000..5cac70ff7 --- /dev/null +++ b/apps/docs/administrators/creating-a-meeting-poll.mdx @@ -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. + +![](/images/meeting-poll/new-meeting.png) + +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**. + +![](/images/meeting-poll/date-picker.png) + + + 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. + + + +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. diff --git a/apps/docs/administrators/creating-a-poll.mdx b/apps/docs/administrators/creating-a-poll.mdx deleted file mode 100644 index 1d3372655..000000000 --- a/apps/docs/administrators/creating-a-poll.mdx +++ /dev/null @@ -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. - -![](/images/administrators/new-meeting.png) - -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**. - -![](/images/administrators/date-picker.png) - -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. diff --git a/apps/docs/administrators/deleting-a-meeting-poll.mdx b/apps/docs/administrators/deleting-a-meeting-poll.mdx new file mode 100644 index 000000000..fc309402c --- /dev/null +++ b/apps/docs/administrators/deleting-a-meeting-poll.mdx @@ -0,0 +1,15 @@ +--- +title: "Deleting a Meeting Poll" +--- + + + Deleting a poll will delete all data related to that poll such as options, + participants and votes. This action cannot be undone. + + +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** diff --git a/apps/docs/administrators/deleting-a-poll.mdx b/apps/docs/administrators/deleting-a-poll.mdx deleted file mode 100644 index 9a9d6f076..000000000 --- a/apps/docs/administrators/deleting-a-poll.mdx +++ /dev/null @@ -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. diff --git a/apps/docs/administrators/editing-a-poll.mdx b/apps/docs/administrators/editing-a-meeting-poll.mdx similarity index 58% rename from apps/docs/administrators/editing-a-poll.mdx rename to apps/docs/administrators/editing-a-meeting-poll.mdx index af4e01695..030733519 100644 --- a/apps/docs/administrators/editing-a-poll.mdx +++ b/apps/docs/administrators/editing-a-meeting-poll.mdx @@ -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. - ![](/images/administrators/editing-poll-1.png) + ![](/images/meeting-poll/editing-poll-1.png) ## 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 -![](/images/administrators/editing-poll-2.png) +![](/images/meeting-poll/editing-poll-2.png) 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 - ![](/images/administrators/editing-poll-3.png) + ![](/images/meeting-poll/editing-poll-3.png) 3. Add/remove options using the date/time picker diff --git a/apps/docs/administrators/sharing-a-poll.mdx b/apps/docs/administrators/sharing-a-meeting-poll.mdx similarity index 81% rename from apps/docs/administrators/sharing-a-poll.mdx rename to apps/docs/administrators/sharing-a-meeting-poll.mdx index 04aa92b7c..5310a9d8f 100644 --- a/apps/docs/administrators/sharing-a-poll.mdx +++ b/apps/docs/administrators/sharing-a-meeting-poll.mdx @@ -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. -![Share Poll](/images/administrators/sharing.png) +![Share Poll](/images/meeting-poll/sharing.png) diff --git a/apps/docs/images/guest-sessions-1.png b/apps/docs/images/guest-sessions-1.png deleted file mode 100644 index b237e118b..000000000 Binary files a/apps/docs/images/guest-sessions-1.png and /dev/null differ diff --git a/apps/docs/images/guest-sessions-2.png b/apps/docs/images/guest-sessions-2.png deleted file mode 100644 index 25003fd9f..000000000 Binary files a/apps/docs/images/guest-sessions-2.png and /dev/null differ diff --git a/apps/docs/images/administrators/admin-page.png b/apps/docs/images/meeting-poll/admin-page.png similarity index 100% rename from apps/docs/images/administrators/admin-page.png rename to apps/docs/images/meeting-poll/admin-page.png diff --git a/apps/docs/images/administrators/date-picker.png b/apps/docs/images/meeting-poll/date-picker.png similarity index 100% rename from apps/docs/images/administrators/date-picker.png rename to apps/docs/images/meeting-poll/date-picker.png diff --git a/apps/docs/images/administrators/editing-poll-1.png b/apps/docs/images/meeting-poll/editing-poll-1.png similarity index 100% rename from apps/docs/images/administrators/editing-poll-1.png rename to apps/docs/images/meeting-poll/editing-poll-1.png diff --git a/apps/docs/images/administrators/editing-poll-2.png b/apps/docs/images/meeting-poll/editing-poll-2.png similarity index 100% rename from apps/docs/images/administrators/editing-poll-2.png rename to apps/docs/images/meeting-poll/editing-poll-2.png diff --git a/apps/docs/images/administrators/editing-poll-3.png b/apps/docs/images/meeting-poll/editing-poll-3.png similarity index 100% rename from apps/docs/images/administrators/editing-poll-3.png rename to apps/docs/images/meeting-poll/editing-poll-3.png diff --git a/apps/docs/images/administrators/new-meeting.png b/apps/docs/images/meeting-poll/new-meeting.png similarity index 100% rename from apps/docs/images/administrators/new-meeting.png rename to apps/docs/images/meeting-poll/new-meeting.png diff --git a/apps/docs/images/administrators/sharing.png b/apps/docs/images/meeting-poll/sharing.png similarity index 100% rename from apps/docs/images/administrators/sharing.png rename to apps/docs/images/meeting-poll/sharing.png diff --git a/apps/docs/images/participants/editing-response-1.png b/apps/docs/images/response/editing-response-1.png similarity index 100% rename from apps/docs/images/participants/editing-response-1.png rename to apps/docs/images/response/editing-response-1.png diff --git a/apps/docs/images/participants/editing-response-2.png b/apps/docs/images/response/editing-response-2.png similarity index 100% rename from apps/docs/images/participants/editing-response-2.png rename to apps/docs/images/response/editing-response-2.png diff --git a/apps/docs/images/participants/editing-response.png b/apps/docs/images/response/editing-response.png similarity index 100% rename from apps/docs/images/participants/editing-response.png rename to apps/docs/images/response/editing-response.png diff --git a/apps/docs/images/participants/submitting-response-1.png b/apps/docs/images/response/submitting-response-1.png similarity index 100% rename from apps/docs/images/participants/submitting-response-1.png rename to apps/docs/images/response/submitting-response-1.png diff --git a/apps/docs/images/participants/submitting-response-2.png b/apps/docs/images/response/submitting-response-2.png similarity index 100% rename from apps/docs/images/participants/submitting-response-2.png rename to apps/docs/images/response/submitting-response-2.png diff --git a/apps/docs/get-started.mdx b/apps/docs/index.mdx similarity index 83% rename from apps/docs/get-started.mdx rename to apps/docs/index.mdx index f6be7813a..3b6801b87 100644 --- a/apps/docs/get-started.mdx +++ b/apps/docs/index.mdx @@ -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 - + Get started by learning how to create a new meeting poll. - + Learn how to run your own instance of Rallly on your own server. diff --git a/apps/docs/mint.json b/apps/docs/mint.json index 959a8c103..349697d6c 100644 --- a/apps/docs/mint.json +++ b/apps/docs/mint.json @@ -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" ] diff --git a/apps/docs/participants/editing-a-response.mdx b/apps/docs/participants/editing-a-response.mdx index 9a7fd12f5..a868ea4e6 100644 --- a/apps/docs/participants/editing-a-response.mdx +++ b/apps/docs/participants/editing-a-response.mdx @@ -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." --- - ![Participant with a "You" badge](/images/participants/editing-response.png) + ![Participant with a "You" badge](/images/response/editing-response.png) 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. - ![](/images/participants/editing-response-1.png) + ![](/images/response/editing-response-1.png) 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. - ![](/images/participants/editing-response-2.png) + ![](/images/response/editing-response-2.png) 1. Select your name in the list of participants. diff --git a/apps/docs/participants/submitting-a-response.mdx b/apps/docs/participants/submitting-a-response.mdx index 20fc45902..4da511188 100644 --- a/apps/docs/participants/submitting-a-response.mdx +++ b/apps/docs/participants/submitting-a-response.mdx @@ -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) -![](/images/participants/submitting-response-1.png) +![](/images/response/submitting-response-1.png) Once you've set your availability click **Continue** to bring up the **New Participant** dialog. - ![](/images/participants/submitting-response-2.png) + ![](/images/response/submitting-response-2.png) Enter your name and your email address in to the form and click **Submit**. diff --git a/apps/docs/self-hosting/configuration-options.mdx b/apps/docs/self-hosting/configuration-options.mdx index 4b80ceafa..e7805209c 100644 --- a/apps/docs/self-hosting/configuration-options.mdx +++ b/apps/docs/self-hosting/configuration-options.mdx @@ -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. | diff --git a/apps/docs/self-hosting/getting-started.mdx b/apps/docs/self-hosting/introduction.mdx similarity index 80% rename from apps/docs/self-hosting/getting-started.mdx rename to apps/docs/self-hosting/introduction.mdx index db120506b..c827f2fb1 100644 --- a/apps/docs/self-hosting/getting-started.mdx +++ b/apps/docs/self-hosting/introduction.mdx @@ -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.