Skip to content

Commit

Permalink
new doc images
Browse files Browse the repository at this point in the history
  • Loading branch information
bastardlee authored and wileymc committed Jan 7, 2025
1 parent 9d890e9 commit 41dec3a
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 34 deletions.
27 changes: 14 additions & 13 deletions pages/docs/content/candidate-guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,15 @@ With Populist, organizations can streamline the process of creating candidate gu

When you create a new candidate guide, you are actually creating a new group of candidate guides that all have the same questions. This allows you to create a bulk number of candidate guides with the same questions. We will refer to these groups as candidate guide groups, and the guides for each race in a group as candidate guides.

### Create Your Questions

<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-add-question.jpg"
width="600px"
/>

### Create Your Questions

Once you create a new candidate guide group, you can add questions that you want to ask candidates, with the following options.
Once you create a new candidate guide group, you can add questions that you want
to ask candidates, with the following options.

#### Tags

Expand All @@ -40,13 +41,13 @@ Once you create a new candidate guide group, you can add questions that you want

- Placeholder text is the copy that is shown in the input field when it is empty - this can be used to give additional context for candidates answering a question.

### Selecting Races

<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-add-race.jpg"
width="600px"
/>

### Selecting Races

Next, add the races with the candidates that you want to ask questions to. Each added race creates a new candidate guide for that race. You can search and filter races in an election with the following options.

#### Election year
Expand All @@ -67,13 +68,13 @@ Next, add the races with the candidates that you want to ask questions to. Each

If you're asking the same questions to candidates across multiple races, simply add each race to the candidate guide group and they will appear under Races.

### Managing Guides

<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-manage-races.jpg"
width="800px"
/>

### Managing Guides

Under Races you'll see all the races that have been added to the candidate guide group. You'll see the following helpful information in the table of races:

#### Name
Expand All @@ -100,13 +101,13 @@ Under Races you'll see all the races that have been added to the candidate guide

- A checkbox to help you manually track whether an email was sent to the candidates in a race.

By clicking on a row in the Races table, you'll be able to access each race's candidate guide management page. On this page you'll find the following information:

<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-manage-guide.jpg"
width="800px"
/>

By clicking on a row in the Races table, you'll be able to access each race's candidate guide management page. On this page you'll find the following information:

#### Candidate Table

- A table of all the candidates in the race. In this table you can edit a candidate's email and phone number, and also directly access the URL to the candidate's personalized form that is used to respond to the questions in the candidate guide.
Expand All @@ -131,13 +132,13 @@ By clicking on a row in the Races table, you'll be able to access each race's ca

- URLs where the candidate guide has been embedded.

### Sending Questions

<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-export.jpg"
width="800px"
/>

### Sending Questions

Once questions and races are added to a candidate guide group, you can export out a spreadsheet of all the candidates in the guide group that includes the following columns:

#### Race Title
Expand Down Expand Up @@ -186,13 +187,13 @@ Once questions and races are added to a candidate guide group, you can export ou

Use this exported spreadsheet with your preferred email list management software to send emails to each of the candidates. Using each column in the spreadsheet, you can personalize the emails to include the candidate's name and the link they will use to respond to the guide questions.

### Managing Submissions

<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-submissions.jpg"
width="800px"
/>

### Managing Submissions

You can access each candidate's submissions by clicking on the Submissions tab at the top of the candidate guide management page. To see responses to each question, click on a question and the submissions will populate in the Responses table below. From this table you can add translations, editorial, and manage duplicate submissions for similar guides.

export default function DocsCandidateGuides({ children }) {
Expand Down
13 changes: 0 additions & 13 deletions pages/docs/content/polls.mdx

This file was deleted.

11 changes: 7 additions & 4 deletions pages/docs/content/questions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@ import { getEmbedConfig } from "utils/constants";

Populist Question embeds allow for open-form responses to questions, helping organizations understand their audiences better. Options include character limits for responses and placeholder text that shows in empty response forms.

<QuestionWidget
embedId={getEmbedConfig()["question"].embedId}
origin={window.location.origin}
<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/question.png"
width="512px"
/>

Poll embeds allow you for responses from a set of predefined answers, with the option to allow respondents to write in a response that is not represented.

<PollWidget embedId={getEmbedConfig()["poll"].embedId} origin={null} />
<img
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/poll.png"
width="512px"
/>

Both types of engagement embeds allow the option for anonymous responses, which when selected means respondents are not required to submit their name and emails.

Expand Down
8 changes: 4 additions & 4 deletions utils/constants.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,12 @@ export const EMBED_CONTENT_IDS = {
politicianId: "40170687-df47-4ad3-87a4-93096a2fb128",
},
poll: {
embedId: "2ec3f7fa-219e-48a4-83a2-0a8f57613c65",
pollId: "3e2f05e2-cd6a-4e30-a9f5-659e18028f6b",
embedId: "6de0123b-f69a-4548-bf4d-d31e3e14cc09",
pollId: "c79c80d1-cb49-4003-9b34-9ccfca4867a6",
},
question: {
embedId: "51e58ff4-2df6-4faf-942c-ec48ee1e19fc",
questionId: "b6df5512-ced1-4fff-8f5e-8f2e877b0986",
embedId: "6f5c8cc2-58fd-4aaf-9297-bb3577748e4f",
questionId: "2ad89ab9-92b8-4593-91fa-875fec0028e1",
},
},
};
Expand Down

0 comments on commit 41dec3a

Please sign in to comment.