Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

📝 Simplify Pro alerts on conferencing integration docs (#3446)

Luke Vella4ba94fe3d145
diff --git a/apps/docs/administrators/deleting-a-meeting-poll.mdx b/apps/docs/administrators/deleting-a-meeting-poll.mdx
index 13a376680..27f64102d 100644
--- a/apps/docs/administrators/deleting-a-meeting-poll.mdx
+++ b/apps/docs/administrators/deleting-a-meeting-poll.mdx
@@ -11,4 +11,13 @@ To delete a meeting poll, from the admin page:
1. Click **Manage**
1. Select **Delete** from the dropdown menu
+
+ <Frame>
+ <img src="/images/administrators/delete-poll-menu.png" alt="The Manage menu on the poll admin page with Delete at the bottom" />
+ </Frame>
+
1. Click **Delete** to confirm
+
+ <Frame>
+ <img src="/images/administrators/delete-poll-confirm.png" alt="The Delete poll confirmation dialog with Cancel and Delete buttons" />
+ </Frame>
diff --git a/apps/docs/images/administrators/delete-poll-confirm.png b/apps/docs/images/administrators/delete-poll-confirm.png
new file mode 100644
index 000000000..7f1a1717b
Binary files /dev/null and b/apps/docs/images/administrators/delete-poll-confirm.png differ
diff --git a/apps/docs/images/administrators/delete-poll-menu.png b/apps/docs/images/administrators/delete-poll-menu.png
new file mode 100644
index 000000000..5424aa346
Binary files /dev/null and b/apps/docs/images/administrators/delete-poll-menu.png differ
diff --git a/apps/docs/images/integrations/microsoft-teams/connect-account.png b/apps/docs/images/integrations/microsoft-teams/connect-account.png
new file mode 100644
index 000000000..c1ac7fd7a
Binary files /dev/null and b/apps/docs/images/integrations/microsoft-teams/connect-account.png differ
diff --git a/apps/docs/images/integrations/microsoft-teams/connected-account.png b/apps/docs/images/integrations/microsoft-teams/connected-account.png
new file mode 100644
index 000000000..acc99538d
Binary files /dev/null and b/apps/docs/images/integrations/microsoft-teams/connected-account.png differ
diff --git a/apps/docs/images/integrations/microsoft-teams/selected.png b/apps/docs/images/integrations/microsoft-teams/selected.png
new file mode 100644
index 000000000..2f8d61961
Binary files /dev/null and b/apps/docs/images/integrations/microsoft-teams/selected.png differ
diff --git a/apps/docs/images/integrations/microsoft-teams/video-call-menu.png b/apps/docs/images/integrations/microsoft-teams/video-call-menu.png
new file mode 100644
index 000000000..aef908b4e
Binary files /dev/null and b/apps/docs/images/integrations/microsoft-teams/video-call-menu.png differ
diff --git a/apps/docs/images/integrations/webex/connect-account.png b/apps/docs/images/integrations/webex/connect-account.png
new file mode 100644
index 000000000..c1ac7fd7a
Binary files /dev/null and b/apps/docs/images/integrations/webex/connect-account.png differ
diff --git a/apps/docs/images/integrations/webex/connected-account.png b/apps/docs/images/integrations/webex/connected-account.png
new file mode 100644
index 000000000..b1ad7a545
Binary files /dev/null and b/apps/docs/images/integrations/webex/connected-account.png differ
diff --git a/apps/docs/images/integrations/webex/selected.png b/apps/docs/images/integrations/webex/selected.png
new file mode 100644
index 000000000..d51346b62
Binary files /dev/null and b/apps/docs/images/integrations/webex/selected.png differ
diff --git a/apps/docs/images/integrations/webex/video-call-menu.png b/apps/docs/images/integrations/webex/video-call-menu.png
new file mode 100644
index 000000000..f948d6c25
Binary files /dev/null and b/apps/docs/images/integrations/webex/video-call-menu.png differ
diff --git a/apps/docs/images/spaces/billing.png b/apps/docs/images/spaces/billing.png
new file mode 100644
index 000000000..426d78d2f
Binary files /dev/null and b/apps/docs/images/spaces/billing.png differ
diff --git a/apps/docs/images/spaces/manage-seats.png b/apps/docs/images/spaces/manage-seats.png
new file mode 100644
index 000000000..e8e0ca852
Binary files /dev/null and b/apps/docs/images/spaces/manage-seats.png differ
diff --git a/apps/docs/images/spaces/members.png b/apps/docs/images/spaces/members.png
new file mode 100644
index 000000000..50abf87f2
Binary files /dev/null and b/apps/docs/images/spaces/members.png differ
diff --git a/apps/docs/integrations/microsoft-teams.mdx b/apps/docs/integrations/microsoft-teams.mdx
index 63affac24..62f71811e 100644
--- a/apps/docs/integrations/microsoft-teams.mdx
+++ b/apps/docs/integrations/microsoft-teams.mdx
@@ -7,7 +7,7 @@ description: Connect your Microsoft work or school account so Rallly creates the
With the Microsoft Teams integration, Rallly creates a Teams meeting on your Microsoft account at the moment you finalize a poll. The join link goes into the event, the calendar invite and the confirmation emails, so participants never wait for a link to follow.
<Callout icon="gem" color="#4f46e5">
- Microsoft Teams meeting links require a [Pro subscription](https://rallly.co/pricing) on rallly.co. Connecting your account works on every plan, but choosing Microsoft Teams as the video call for a poll is a Pro feature.
+ Microsoft Teams requires a [Pro subscription](https://rallly.co/pricing).
</Callout>
## How it works
@@ -33,9 +33,17 @@ The meeting is created on the Microsoft account you connected, so it follows you
</Step>
<Step title="Connect your account">
Next to **Microsoft Teams**, click **Connect**. You are sent to Microsoft to pick your work or school account and sign in.
+
+<Frame>
+ <img src="/images/integrations/microsoft-teams/connect-account.png" alt="The Conferencing settings page listing Microsoft Teams with a Connect button" />
+</Frame>
</Step>
<Step title="Approve the permissions">
Microsoft shows what Rallly is asking for (listed under [Permissions](#permissions)). Click **Accept**. You are returned to Rallly, where the email address of your Microsoft account appears next to Microsoft Teams.
+
+<Frame>
+ <img src="/images/integrations/microsoft-teams/connected-account.png" alt="The Conferencing settings page showing the connected account's email address next to Microsoft Teams" />
+</Frame>
</Step>
</Steps>
@@ -65,6 +73,14 @@ After the administrator approves, connect Microsoft Teams again. Microsoft no lo
When creating a poll, click **Add video call** and choose **Microsoft Teams**. The form shows "Microsoft Teams" as the video call for this poll.
+<Frame>
+ <img src="/images/integrations/microsoft-teams/video-call-menu.png" alt="The Add video call menu on the poll form, listing connected and available providers, then Custom" />
+</Frame>
+
+<Frame>
+ <img src="/images/integrations/microsoft-teams/selected.png" alt="The poll form with Microsoft Teams chosen as the video call" />
+</Frame>
+
If your Microsoft Teams account is not connected, the form tells you so and links to Conferencing settings.
Participants see "Microsoft Teams" on the poll page while voting is open. No meeting link exists yet.
diff --git a/apps/docs/integrations/webex.mdx b/apps/docs/integrations/webex.mdx
index b3129fe2e..35f2b0f16 100644
--- a/apps/docs/integrations/webex.mdx
+++ b/apps/docs/integrations/webex.mdx
@@ -7,7 +7,7 @@ description: Connect your Webex account so Rallly creates the Webex meeting link
With the Webex integration, Rallly creates a Webex meeting on your account at the moment you finalize a poll. The join link goes into the event, the calendar invite and the confirmation emails, so participants never wait for a link to follow.
<Callout icon="gem" color="#4f46e5">
- Webex meeting links require a [Pro subscription](https://rallly.co/pricing) on rallly.co. Connecting your account works on every plan, but choosing Webex as the video call for a poll is a Pro feature.
+ Webex requires a [Pro subscription](https://rallly.co/pricing).
</Callout>
## How it works
@@ -32,9 +32,17 @@ The meeting is created on the Webex account you connected, so it follows that ac
</Step>
<Step title="Connect your account">
Next to **Webex**, click **Connect**. You are sent to Webex to sign in.
+
+<Frame>
+ <img src="/images/integrations/webex/connect-account.png" alt="The Conferencing settings page listing Webex with a Connect button" />
+</Frame>
</Step>
<Step title="Approve the permissions">
Webex shows what Rallly is asking for (listed under [Permissions](#permissions)). Click **Accept**. You are returned to Rallly, where the email address of your Webex account appears next to Webex.
+
+<Frame>
+ <img src="/images/integrations/webex/connected-account.png" alt="The Conferencing settings page showing the connected account's email address next to Webex" />
+</Frame>
</Step>
</Steps>
@@ -50,6 +58,14 @@ A Webex administrator can block integrations for everyone in the organization, o
When creating a poll, click **Add video call** and choose **Webex**. The form shows "Webex" as the video call for this poll.
+<Frame>
+ <img src="/images/integrations/webex/video-call-menu.png" alt="The Add video call menu on the poll form, listing connected and available providers, then Custom" />
+</Frame>
+
+<Frame>
+ <img src="/images/integrations/webex/selected.png" alt="The poll form with Webex chosen as the video call" />
+</Frame>
+
If your Webex account is not connected, the form tells you so and links to Conferencing settings.
Participants see "Webex" on the poll page while voting is open. No meeting link exists yet.
diff --git a/apps/docs/integrations/zoom.mdx b/apps/docs/integrations/zoom.mdx
index 75421cb00..a67fb9e41 100644
--- a/apps/docs/integrations/zoom.mdx
+++ b/apps/docs/integrations/zoom.mdx
@@ -7,7 +7,7 @@ description: Connect your Zoom account so Rallly creates the meeting link when y
With the Zoom integration, Rallly creates a Zoom meeting on your account at the moment you finalize a poll. The join link goes into the event, the calendar invite and the confirmation emails, so participants never wait for a link to follow.
<Callout icon="gem" color="#4f46e5">
- Zoom meeting links require a [Pro subscription](https://rallly.co/pricing) on rallly.co. Connecting your account works on every plan, but choosing Zoom as the video call for a poll is a Pro feature.
+ Zoom requires a [Pro subscription](https://rallly.co/pricing).
</Callout>
## How it works
diff --git a/apps/docs/spaces/billing.mdx b/apps/docs/spaces/billing.mdx
index f43109a6b..19fa1f335 100644
--- a/apps/docs/spaces/billing.mdx
+++ b/apps/docs/spaces/billing.mdx
@@ -50,7 +50,11 @@ To upgrade your space to Pro:
### Managing Seats
-You can adjust your seat allocation at any time:
+You can adjust your seat allocation at any time from the Billing page of a Pro space:
+
+<Frame>
+ <img src="/images/spaces/billing.png" alt="The Billing page showing the active Pro plan, its seats and renewal date, with Manage seats and Manage billing buttons" />
+</Frame>
#### Adding Seats
When you need to invite more members:
diff --git a/apps/docs/spaces/managing-seats.mdx b/apps/docs/spaces/managing-seats.mdx
index 3714b4ef4..72107b2fa 100644
--- a/apps/docs/spaces/managing-seats.mdx
+++ b/apps/docs/spaces/managing-seats.mdx
@@ -33,10 +33,18 @@ When you need to invite more team members than your current seat allocation allo
<Step title="Click Manage Seats">
Once your space is upgraded to Pro, you'll see a "Manage Seats" button on the billing page.
+
+ <Frame>
+ <img src="/images/spaces/billing.png" alt="The Billing page showing the active Pro plan with the Manage seats button" />
+ </Frame>
</Step>
<Step title="Increase Seat Count">
Use the seat selector to increase the number of seats to accommodate your new team members.
+
+ <Frame>
+ <img src="/images/spaces/manage-seats.png" alt="The Manage seats dialog with a seat selector and the number of seats in use" />
+ </Frame>
<Note>
You can increase seats to any number you need. There's no upper limit on seat allocation.
diff --git a/apps/docs/spaces/members.mdx b/apps/docs/spaces/members.mdx
index 60c92653e..93bf4e1cf 100644
--- a/apps/docs/spaces/members.mdx
+++ b/apps/docs/spaces/members.mdx
@@ -46,6 +46,10 @@ Before inviting members, ensure:
<Steps>
<Step title="Navigate to Members">
Go to your space settings and click on the "Members" tab.
+
+ <Frame>
+ <img src="/images/spaces/members.png" alt="The Members page listing each member with their role, the number of seats available and the Invite member button" />
+ </Frame>
</Step>
<Step title="Send Invitation">
diff --git a/packages/screenshots/capture/docs-conferencing.spec.ts b/packages/screenshots/capture/docs-conferencing.spec.ts
new file mode 100644
index 000000000..a772df259
--- /dev/null
+++ b/packages/screenshots/capture/docs-conferencing.spec.ts
@@ -0,0 +1,147 @@
+import type { Page } from "@playwright/test";
+import { test } from "@playwright/test";
+import { prisma } from "@rallly/database";
+import { deleteAllMessages, loginWithEmail } from "@rallly/test-helpers";
+import { encrypt } from "@rallly/utils/encryption";
+import { docsImagePath } from "./helpers";
+
+test.use({ deviceScaleFactor: 2 });
+
+const userId = "user-1";
+
+const providers = [
+ {
+ provider: "teams",
+ label: "Microsoft Teams",
+ dir: "microsoft-teams",
+ scopes: ["OnlineMeetings.ReadWrite"],
+ email: "[email protected]",
+ },
+ {
+ provider: "webex",
+ label: "Webex",
+ dir: "webex",
+ scopes: ["meeting:schedules_write", "spark:people_read"],
+ email: "[email protected]",
+ },
+] as const;
+
+async function clearConnections() {
+ await prisma.conferencingConnection.deleteMany({
+ where: { userId, provider: { in: providers.map((p) => p.provider) } },
+ });
+ await prisma.credential.deleteMany({
+ where: { userId, provider: { in: ["microsoft", "webex"] } },
+ });
+}
+
+async function seedConnection({
+ provider,
+ scopes,
+ email,
+ label,
+}: {
+ provider: string;
+ scopes: readonly string[];
+ email: string;
+ label: string;
+}) {
+ const secretPassword = process.env.SECRET_PASSWORD;
+ if (!secretPassword) {
+ throw new Error("SECRET_PASSWORD is required to seed a credential");
+ }
+ const credentialProvider = provider === "teams" ? "microsoft" : provider;
+ const integrationId = provider === "teams" ? "microsoft-teams" : provider;
+ const providerAccountId = `docs-${provider}`;
+ const credential = await prisma.credential.create({
+ data: {
+ userId,
+ provider: credentialProvider,
+ providerAccountId,
+ type: "OAUTH",
+ secret: encrypt(
+ JSON.stringify({ accessToken: "docs-token", scopes }),
+ secretPassword,
+ ),
+ scopes: [...scopes],
+ },
+ });
+ await prisma.conferencingConnection.create({
+ data: {
+ userId,
+ provider,
+ integrationId,
+ providerAccountId,
+ email,
+ displayName: label,
+ credentialId: credential.id,
+ },
+ });
+}
+
+async function settle(page: Page) {
+ await page.waitForLoadState("networkidle");
+ await page.evaluate(() => document.fonts.ready);
+}
+
+test.beforeAll(clearConnections);
+test.afterAll(clearConnections);
+
+for (const { provider, label, dir, scopes, email } of providers) {
+ test(`${dir} screenshots`, async ({ page }) => {
+ await clearConnections();
+ await page.setViewportSize({ width: 1280, height: 900 });
+ await deleteAllMessages();
+ await loginWithEmail(page, { email: "[email protected]" });
+
+ await page.goto("/settings/conferencing");
+ await settle(page);
+ await page.screenshot({
+ path: docsImagePath(`integrations/${dir}/connect-account`),
+ clip: { x: 0, y: 0, width: 1280, height: 640 },
+ });
+
+ await seedConnection({ provider, scopes, email, label });
+ await page.goto("/settings/conferencing");
+ await settle(page);
+ await page.screenshot({
+ path: docsImagePath(`integrations/${dir}/connected-account`),
+ clip: { x: 0, y: 0, width: 1280, height: 640 },
+ });
+
+ await page.goto("/new");
+ await settle(page);
+ const form = page.locator("#create-poll");
+ const formBox = await form.boundingBox();
+ if (!formBox) throw new Error("poll form not visible");
+ await page.getByRole("button", { name: "Add video call" }).click();
+ await page.getByRole("menuitem", { name: label }).waitFor();
+ const menuBox = await page.getByRole("menu").boundingBox();
+ if (!menuBox) throw new Error("menu not visible");
+ await page.screenshot({
+ path: docsImagePath(`integrations/${dir}/video-call-menu`),
+ clip: {
+ x: formBox.x,
+ y: formBox.y,
+ width: formBox.width,
+ height: menuBox.y + menuBox.height - formBox.y + 24,
+ },
+ });
+
+ await page.getByRole("menuitem", { name: label }).click();
+ await form.getByText(label, { exact: true }).waitFor();
+ const addDescription = await page
+ .getByRole("button", { name: "Add description" })
+ .boundingBox();
+ if (!addDescription) throw new Error("form buttons not visible");
+ await page.screenshot({
+ path: docsImagePath(`integrations/${dir}/selected`),
+ clip: {
+ x: formBox.x,
+ y: formBox.y,
+ width: formBox.width,
+ height: addDescription.y + addDescription.height - formBox.y + 24,
+ },
+ });
+ });
+}
diff --git a/packages/screenshots/capture/docs-spaces.spec.ts b/packages/screenshots/capture/docs-spaces.spec.ts
new file mode 100644
index 000000000..f0cd1745d
--- /dev/null
+++ b/packages/screenshots/capture/docs-spaces.spec.ts
@@ -0,0 +1,103 @@
+import type { Locator } from "@playwright/test";
+import { expect, test } from "@playwright/test";
+import { prisma } from "@rallly/database";
+import { deleteAllMessages, loginWithEmail } from "@rallly/test-helpers";
+import { docsImagePath } from "./helpers";
+
+test.use({ deviceScaleFactor: 2, viewport: { width: 1280, height: 900 } });
+
+const pollId = "docs-delete-poll";
+
+// A dialog animates in, so its box is only final once two reads agree.
+async function settledBox(locator: Locator) {
+ await locator.waitFor();
+ let previous = "";
+ await expect
+ .poll(
+ async () => {
+ const current = JSON.stringify(await locator.boundingBox());
+ const settled = current === previous;
+ previous = current;
+ return settled;
+ },
+ { intervals: [100] },
+ )
+ .toBe(true);
+ const box = await locator.boundingBox();
+ if (!box) throw new Error("dialog not visible");
+ return box;
+}
+
+test.beforeAll(async () => {
+ await prisma.poll.delete({ where: { id: pollId } }).catch(() => {});
+ await prisma.poll.create({
+ data: {
+ id: pollId,
+ title: "Team offsite",
+ userId: "user-1",
+ spaceId: "space-2",
+ status: "open",
+ timeZone: "America/New_York",
+ options: {
+ create: [{ startTime: new Date(Date.now() + 7 * 864e5), duration: 60 }],
+ },
+ },
+ });
+});
+
+test.afterAll(async () => {
+ await prisma.poll.delete({ where: { id: pollId } }).catch(() => {});
+});
+
+test("spaces and poll admin screenshots", async ({ page }) => {
+ await deleteAllMessages();
+ await loginWithEmail(page, { email: "[email protected]" });
+
+ await page.goto("/settings/members");
+ await page.waitForLoadState("networkidle");
+ await page.screenshot({
+ path: docsImagePath("spaces/members"),
+ clip: { x: 0, y: 0, width: 1280, height: 360 },
+ });
+
+ await page.goto("/settings/billing");
+ await page.waitForLoadState("networkidle");
+ await page.screenshot({
+ path: docsImagePath("spaces/billing"),
+ clip: { x: 0, y: 0, width: 1280, height: 600 },
+ });
+
+ await page.getByRole("button", { name: "Manage seats" }).click();
+ const seatsDialog = page.getByRole("dialog");
+ const seatsBox = await settledBox(seatsDialog);
+ await page.screenshot({
+ path: docsImagePath("spaces/manage-seats"),
+ clip: {
+ x: seatsBox.x - 40,
+ y: seatsBox.y - 40,
+ width: seatsBox.width + 80,
+ height: seatsBox.height + 80,
+ },
+ });
+
+ await page.goto(`/poll/${pollId}`);
+ await page.waitForLoadState("networkidle");
+ await page.getByRole("button", { name: "Manage" }).click();
+ await page.getByRole("menuitem", { name: "Delete" }).waitFor();
+ await page.screenshot({
+ path: docsImagePath("administrators/delete-poll-menu"),
+ clip: { x: 0, y: 0, width: 1280, height: 560 },
+ });
+ await page.getByRole("menuitem", { name: "Delete" }).click();
+ const confirm = page.getByRole("alertdialog").or(page.getByRole("dialog"));
+ const box = await settledBox(confirm);
+ await page.screenshot({
+ path: docsImagePath("administrators/delete-poll-confirm"),
+ clip: {
+ x: box.x - 40,
+ y: box.y - 40,
+ width: box.width + 80,
+ height: box.height + 80,
+ },
+ });
+});
diff --git a/packages/screenshots/capture/helpers.ts b/packages/screenshots/capture/helpers.ts
index 29a7025eb..c970c1297 100644
--- a/packages/screenshots/capture/helpers.ts
+++ b/packages/screenshots/capture/helpers.ts
@@ -1,3 +1,7 @@
export function screenshotPath(name: string) {
return `screenshots/${name}.png`;
}
+
+export function docsImagePath(name: string) {
+ return `../../apps/docs/images/${name}.png`;
+}
diff --git a/packages/screenshots/package.json b/packages/screenshots/package.json
index 46df7f64e..ae6b5dbde 100644
--- a/packages/screenshots/package.json
+++ b/packages/screenshots/package.json
@@ -7,6 +7,7 @@
"dependencies": {
"@rallly/database": "workspace:*",
"@rallly/test-helpers": "workspace:*",
+ "@rallly/utils": "workspace:*",
"dayjs": "^1.11.13",
"dotenv": "^17.2.4",
"nanoid": "^5.0.9"
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 70c9a07b3..d768f823f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -715,6 +715,9 @@ importers:
'@rallly/test-helpers':
specifier: workspace:*
version: link:../test-helpers
+ '@rallly/utils':
+ specifier: workspace:*
+ version: link:../utils
dayjs:
specifier: ^1.11.13
version: 1.11.19