📝 Update Documentation (#881)

This commit is contained in:
Luke Vella 2023-09-21 10:46:17 +01:00 committed by GitHub
parent fc34858f86
commit 7ca9bd5a82
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
28 changed files with 239 additions and 212 deletions

View file

@ -1,42 +0,0 @@
---
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>![](/images/meeting-poll/new-meeting.png)</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**.
<Accordion title="How do I manage timezones?">
If you do choose to specify times, Rallly will automatically detect and set the timezone from your browser
and participants will see times adjusted to their timezone when they vote. This behavior is ideal for remote meetings where
participants can be in different timezones.
If 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 regardless of their timezone.
</Accordion>
<Frame>![](/images/meeting-poll/date-picker.png)</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.

View file

@ -1,5 +1,5 @@
---
title: "Deleting a Meeting Poll"
title: "Delete a Poll"
---
<Warning>
@ -11,5 +11,4 @@ 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**

View file

@ -1,5 +1,5 @@
---
title: "Editing a Meeting Poll"
title: "Edit a Poll"
description: "How to make changes to an existing meeting poll."
---

View file

@ -1,16 +0,0 @@
---
title: "Sharing a Meeting Poll"
description: "How to share a meeting poll with participants."
---
### Sharing with participants
To share your poll with participants, from the admin page:
1. Click on the **Share** button to open the popover.
2. Inside the popover you will see a link to the **Participant Page** for your poll. Copy
this link and send it to your participants via email or whichever way you
prefer to communicate with your participants.
<Frame>![Share Poll](/images/meeting-poll/sharing.png)</Frame>

View file

@ -1,20 +1,20 @@
---
icon: "message-question"
title: "FAQ"
description: "Frequently asked questions about Rallly."
---
<Accordion title="Is Rallly free?">
Yes, Rallly is completely free to use. In the future there may be an option to
pay for additional features but the core functionality will always be free.
If you would like to support Rallly, you can do so by [donating](/contribute/donations).
Most of Rallly's features are free and many users will never need to pay for
anything. However, there are some features that are only available to paying
customers. These features are designed to help you get the most out of Rallly
and also help pay for the cost of running and maintaining the service.
</Accordion>
<Accordion title="Do I need to create an account to use Rallly?">
No, you don't! You can create and share polls without creating an account.
However, if you do create an account, you will have access to additional
features such as notifications.
However, some features (like email notifications) are only available to users
with an account.
</Accordion>
<Accordion title="Are there any limits to the number of polls, participants and options I can make?">
@ -25,7 +25,8 @@ If you would like to support Rallly, you can do so by [donating](/contribute/don
<Accordion title="How long will Rallly keep my meeting poll?">
Meeting polls are automatically deleted when all date options are in the past
AND the meeting poll has not been accessed for over 30 days.
AND the meeting poll has not been accessed for over 30 days. This doesn't
apply if you have an paid subscription that is active.
</Accordion>
<Accordion title="Can I limit the number of participants that can vote for an option?">
@ -41,7 +42,8 @@ If you would like to support Rallly, you can do so by [donating](/contribute/don
Not there?
If the email is not in your spam folder and you're not receiving *any* emails from us, it's possible that you've been added to our suppression list.
If the email is not in your spam folder and you're not receiving _any_ emails from us, it's possible that you've been added to our suppression list.
This can happen if you or your email provider mark an email from Rallly as spam.
If you think this has happened, please [contact us](/contact) and we'll remove you from the list.
</Accordion>

View file

@ -0,0 +1,56 @@
---
icon: user
title: "Participant Guide"
description: "How to respond to a Rallly poll"
---
<Steps>
<Step title="Select your preferred dates">
Click the button under each date to toggle through the answers:
1. Yes
2. If need be
3. No
<Note>If you leave an option unselected, it will be counted as a **No** vote.</Note>
<Frame>![Submit a Response](/images/voting-in-progress.png)</Frame>
When you're done, click **Continue**.
</Step>
<Step title="Enter your details">
Enter your name and email address, then click **Submit**.
<Tip>To ensure you don't lose the ability to edit your response, enter your email address to receive a confirmation email with a magic link that identifies you .</Tip>
<Frame>![Submit a Response](/images/voting-submitting.png)</Frame>
</Step>
<Step title="Done!">
If you need to make changes, you can use the dropdown menu next to your name.
<Frame>![Submit a Response](/images/voting-submitted.png)</Frame>
</Step>
</Steps>
### Frequently Asked Questions
<AccordionGroup>
<Accordion title="Why can't I edit my response?">
Rallly uses cookies in your browser to recognize you as the creator of a
response. If your cookies have been deleted or you are using a different
device/browser, you may no longer be recognized as the user who created the response.
In this case you should ask the administrator of the poll to either delete your
response so that you can create a new one or to edit your response for you.
</Accordion>
<Accordion title="How can I avoid losing access to my own response?">
If you enter your email address when you submit your response, you will
receive a confirmation email with a link that allows you to edit your response from
anywhere.
</Accordion>
</AccordionGroup>

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

BIN
apps/docs/images/review.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

BIN
apps/docs/images/voting.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

View file

@ -1,13 +1,14 @@
---
icon: "house"
title: "Introduction"
description: "Welcome to the official documentation for Rallly."
---
<Frame>![Rallly Splash Image](/images/self-hosting/splash.png)</Frame>
## What is Rallly?
Rallly is a tool for creating meeting polls. It's designed to help you
schedule meetings with groups of people. It's free to use and
you can create as many polls as you want.
Rallly is a tool for creating scheduling polls. It's designed to help people find a common time to schedule a meeting or event.
> Rallly is pronounced like "rally" but with an extra _L_.
>
@ -16,24 +17,27 @@ you can create as many polls as you want.
>
> -- [Luke Vella](https://twitter.com/imlukevella), Creator of Rallly
## What is a Meeting Poll?
## What is a Scheduling Poll?
A meeting poll is a poll that helps you find a time that works for everyone. The host
of the meeting will typically select a few date and time options for participants to choose
from and then tally the results to find the best time.
## Guides
Scheduling polls helps you find a time that works for everyone. The host
of the meeting will typically select a few date and time options for participants to vote
for and then select the most suitable option.
<CardGroup cols={2}>
<Card title="Guides for Administrators" icon="user" href="/administrators">
How to create a new meeting poll
<Card title="Workflow" icon="user" href="/workflow">
Learn how scheduling polls work
</Card>
<Card title="Guides for Participants" icon="users" href="/participants">
How to respond to a meeting poll
How to respond to a scheduling poll
</Card>
</CardGroup>
## Contribute
## How much does it cost?
This project is supported by the generosity of its users. Help us keep Rallly free and open-source by [donating](/contribute/donations) or check out
our [contributing guide](/contribute) to learn how you can help.
Most of Rallly's features are free and many users will never need to pay for anything.
However, there are some features that are only available to paying customers.
These features are designed to help you get the most out of Rallly.
<Card title="Pricing" icon="gem" href="https://rallly.co/pricing">
Learn more about Rallly's pricing
</Card>

View file

@ -6,9 +6,12 @@
},
"favicon": "/favicon.png",
"colors": {
"primary": "#4f46e5",
"primary": "#4F46E5",
"light": "#6366f1",
"dark": "#1f2937",
"dark": "#4F46E5",
"background": {
"light": "#F9FAFB"
},
"anchors": { "from": "#878AFA", "to": "#4347F1" }
},
"topbarCtaButton": {
@ -25,17 +28,20 @@
"url": "contact"
}
],
"tabs": [
"anchors": [
{
"name": "Self-Hosting",
"icon": "server",
"url": "self-hosting"
},
{
"name": "Contributing Guide",
"icon": "hand-holding-heart",
"url": "contribute"
},
{
"name": "Contact",
"icon": "messages",
"url": "contact"
}
],
@ -45,20 +51,12 @@
"pages": ["introduction", "faq"]
},
{
"group": "Guides for Administrators",
"pages": [
"administrators/creating-a-meeting-poll",
"administrators/sharing-a-meeting-poll",
"administrators/editing-a-meeting-poll",
"administrators/deleting-a-meeting-poll"
]
"group": "How it Works",
"pages": ["workflow/create", "workflow/invite", "workflow/finalize"]
},
{
"group": "Guides for Participants",
"pages": [
"participants/submitting-a-response",
"participants/editing-a-response"
]
"group": "Guides",
"pages": ["guide/participant-guide"]
},
{
"group": "Self-Hosting",
@ -93,6 +91,7 @@
],
"footerSocials": {
"twitter": "https://twitter.com/ralllyco",
"linkedin": "https://www.linkedin.com/company/rallly/",
"github": "https://github.com/lukevella/rallly",
"discord": "https://discord.com/invite/uzg4ZcHbuM",
"website": "https://rallly.co/"
@ -100,5 +99,23 @@
"feedback": {
"suggestEdit": true,
"raiseIssue": true
},
"redirects": [
{
"source": "/administrators/creating-a-meeting-poll",
"destination": "/workflow/create"
},
{
"source": "/administrators/sharing-a-meeting-poll",
"destination": "/workflow/invite"
},
{
"source": "/participants/submitting-a-response",
"destination": "/guide/participant-guide"
},
{
"source": "/participants/editing-a-response",
"destination": "/guide/participant-guide"
}
]
}

View file

@ -1,68 +0,0 @@
---
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">
![Participant with a "You" badge](/images/response/editing-response.png)
</Frame>
If you see your response but it doesn't have this badge, it means we can't tell
that you're the same person, either because you are using a different device or
browser or because your cookies have been deleted. In this case you may need to
contact the organizer of your poll to delete your response so that you can make
a new one.
If you enter your email when you create a response, you will receive a link that
will allow you to edit your response from anywhere.
### Edit votes
<Tabs>
<Tab title="On Desktop">
<Frame caption="Click the 'Edit votes' menu item to begin editing">
![](/images/response/editing-response-1.png)
</Frame>
1. Click the 3 dots icon to open up the dropdown menu.
2. Click "Edit" to begin editing your response.
3. Select the dates you are available.
4. Click "Save" to save your changes.
</Tab>
<Tab title="On Mobile">
<Frame caption="Click the 'Edit votes' menu item to begin editing">
![](/images/response/editing-response-2.png)
</Frame>
1. Select your name in the list of participants.
2. Click "Edit" to begin editing your response.
3. Select the dates you are available.
4. Click "Save" to save your changes.
</Tab>
</Tabs>
### Frequently asked questions
<AccordionGroup>
<Accordion title="Why can't I edit my response?">
Rallly uses cookies in your browser to recognize you as the creator of a
response. If your cookies have been deleted or you are using a different
device/browser, you may no longer be recognized as the user who created the response.
In this case you should ask the administrator of the poll to either delete your
response so that you can create a new one or to edit your response for you.
</Accordion>
<Accordion title="How can I avoid losing access to my own response?">
If you enter your email address when you submit your response, you will
receive a confirmation email with a link that allows you to edit your response from
anywhere.
</Accordion>
</AccordionGroup>

View file

@ -1,20 +0,0 @@
---
title: "Submitting a Response"
description: "To respond to a poll, start by clicking the buttons under the
corresponding dates to set your availability."
---
- Yes (1 click)
- If need be (2 clicks)
- No (3 clicks or leave blank)
<Frame>![](/images/response/submitting-response-1.png)</Frame>
Once you've set your availability click **Continue** to bring up the **New
Participant** dialog.
<Frame caption="The New Pariticpant Dialog">
![](/images/response/submitting-response-2.png)
</Frame>
Enter your name and your email address in to the form and click **Submit**.

View file

@ -7,7 +7,7 @@ description: How to Self-Host Rallly
Rallly is 100% open-source and available under the [GNU Affero General Public License v3.0 (AGPL-3.0)](https://github.com/lukevella/rallly/blob/main/LICENSE)
which allows you to run your own instance of Rallly for free for both personal and commercial use.
![Screenshots of Rallly](/images/self-hosting/splash.png)
<Frame>![Rallly Splash Image](/images/self-hosting/splash.png)</Frame>
## Official Docker Image

View file

@ -0,0 +1,38 @@
---
icon: "circle-1"
title: "Create a Poll"
description: "How to create a scheduling poll with Rallly"
---
Go to [app.rallly.co](https://app.rallly.co) and click
on [New Poll](https://app.rallly.co/new).
<Steps>
<Step title="Enter Event Details">
Enter the title of your poll. You can also add a description to your poll if
you want to give your participants more information about the event.
<Frame>![New Poll Page](/images/new-poll-page.png)</Frame>
</Step>
<Step title="Select Dates or Times">
Use the calendar to select various options for your participants to vote for.
<Tabs>
<Tab title="Month View">
<Frame caption="Use Month View to select dates or create repeating time slots">
![Month View](/images/month-view.png)
</Frame>
</Tab>
<Tab title="Week View">
<Frame caption="Use Week View to draw time slot options on a calendar">
![Week View](/images/week-view.png)
</Frame>
</Tab>
</Tabs>
</Step>
<Step title="Click Create Poll">
Click the <strong>Create Poll</strong> button to create your poll and get your **Invite Link**.
</Step>
</Steps>
Once your poll is created you can start [inviting participants](/workflow/invite) to your poll.

View file

@ -0,0 +1,27 @@
---
icon: "circle-3"
title: "Finalize"
description: "Pick a final date for your event"
---
<Steps>
<Step title="Review your results">
Click **Manage** and select **Finalize** from the dropdown menu.
<Frame>![Finalize](/images/finalize.png)</Frame>
</Step>
<Step title="Finalize">
Select your preferred date from the list and click **Finalize**.
This will:
1. Send an email to you with a calendar invite for the selected date
2. Send an email to the attendees with the calendar invite.
3. Close the poll and prevent any further votes.
The selected date will be displayed on your finalized poll for everyone to see.
<Frame>![Finalized Poll](/images/finalized.png)</Frame>
</Step>
</Steps>

View file

@ -0,0 +1,29 @@
---
icon: "circle-2"
title: "Invite Participants"
description: "Collect responses from your participants by sharing your invite link"
---
<Steps>
<Step title="Share your Invite Link">
Click the **Share** button to open the dialog containing your **Invite
Link**.
<Frame caption="Hint: You can copy the link by clicking on it">
![Share Dialog](/images/invite-link.png)
</Frame>
</Step>
<Step title="Wait for participants to vote">
Participants can submit their votes by following the instructions.
<Note>Have a look at the [Participant Guide](/guide/participant-guide) for details on how participants can vote.</Note>
<Frame>![Voting](/images/voting.png)</Frame>
As participants respond, you can review the results to see which dates are preferred.
<Frame>![Voting](/images/review.png)</Frame>
</Step>
</Steps>
Once all participants have responded you can proceed with [finalizing your poll](/workflow/finalize).

View file

@ -22,5 +22,6 @@
"findATime": "Find a Time",
"getStarted": "Get started",
"availabilityPoll": "Availability Poll",
"solutions": "Solutions"
"solutions": "Solutions",
"howItWorks": "How it Works"
}

View file

@ -1,11 +1,4 @@
import {
ChevronRightIcon,
GemIcon,
LifeBuoyIcon,
LogInIcon,
MenuIcon,
NewspaperIcon,
} from "@rallly/icons";
import { ChevronRightIcon, MenuIcon } from "@rallly/icons";
import { cn } from "@rallly/ui";
import {
DropdownMenu,
@ -37,7 +30,7 @@ const NavLink = ({
return (
<Link
className={cn(
"rounded text-sm font-medium",
"inline-flex items-center gap-x-2.5 rounded text-sm font-medium",
isActive ? "" : "hover:text-primary text-muted-foreground ",
className,
)}
@ -51,6 +44,9 @@ const Menu: React.FunctionComponent<{ className: string }> = ({
}) => {
return (
<nav className={className}>
<NavLink href="https://support.rallly.co/workflow">
<Trans i18nKey="howItWorks" defaults="How it Works" />
</NavLink>
<NavLink href="/pricing">
<Trans i18nKey="pricing" />
</NavLink>
@ -96,12 +92,12 @@ const PageLayout: React.FunctionComponent<PageLayoutProps> = ({ children }) => {
<Link className="inline-block rounded" href="/">
<Image src="/logo.svg" width={130} height={30} alt="rallly.co" />
</Link>
<Menu className="hidden items-center space-x-8 sm:flex" />
<Menu className="hidden items-center space-x-8 lg:flex" />
</div>
<div className="flex items-center gap-4 sm:gap-8">
<Link
href={linkToApp("/login")}
className="hover:text-primary text-muted-foreground hidden rounded text-sm font-medium hover:no-underline hover:underline-offset-2 sm:inline-flex"
className="hover:text-primary text-muted-foreground hidden rounded text-sm font-medium hover:no-underline hover:underline-offset-2 lg:inline-flex"
>
<Trans i18nKey="login" defaults="Login" />
</Link>
@ -114,7 +110,7 @@ const PageLayout: React.FunctionComponent<PageLayoutProps> = ({ children }) => {
</span>
<ChevronRightIcon className="inline-block h-4 w-4 transition-all group-active:translate-x-1" />
</Link>
<div className="flex items-center justify-center sm:hidden">
<div className="flex items-center justify-center lg:hidden">
<DropdownMenu>
<DropdownMenuTrigger>
<MenuIcon className="h-6 w-6" />
@ -123,10 +119,9 @@ const PageLayout: React.FunctionComponent<PageLayoutProps> = ({ children }) => {
<DropdownMenuItem asChild>
<Link
className="flex items-center gap-3 p-2 text-lg"
href="/blog"
href="https://support.rallly.co"
>
<NewspaperIcon className="h-5 w-5" />
<Trans i18nKey="blog" />
<Trans i18nKey="howItWorks" defaults="How it Works" />
</Link>
</DropdownMenuItem>
<DropdownMenuItem asChild>
@ -134,16 +129,22 @@ const PageLayout: React.FunctionComponent<PageLayoutProps> = ({ children }) => {
className="flex items-center gap-3 p-2 text-lg"
href="/pricing"
>
<GemIcon className="h-5 w-5" />
<Trans i18nKey="pricing" defaults="Pricing" />
</Link>
</DropdownMenuItem>
<DropdownMenuItem asChild>
<Link
className="flex items-center gap-3 p-2 text-lg"
href="/blog"
>
<Trans i18nKey="blog" />
</Link>
</DropdownMenuItem>
<DropdownMenuItem asChild>
<Link
className="flex items-center gap-3 p-2 text-lg"
href="https://support.rallly.co"
>
<LifeBuoyIcon className="h-5 w-5" />
<Trans i18nKey="support" />
</Link>
</DropdownMenuItem>
@ -153,7 +154,6 @@ const PageLayout: React.FunctionComponent<PageLayoutProps> = ({ children }) => {
className="flex items-center gap-3 p-2 text-lg"
href={linkToApp("/login")}
>
<LogInIcon className="h-5 w-5" />
<Trans i18nKey="login" defaults="Login" />
</Link>
</DropdownMenuItem>