Localise, rename and move everything to do with canvassing #2443

ziggabyte · 2024-12-20T16:32:42Z

Description

This PR adds localisation, changes some names, moves code around and attempts to make the code easier to manage.

Screenshots

none

Changes

renames the former "areas" section to "geography"
renames the former "outcomes" tab to "report"
splits the code into organiser-facing "areaAssignments" folder, and activist facing "canvass" folder
adds localisation to these features
renames what was formerly known as "places" to "locations"
changes names of files to match all these changes
merges in and adds translations for the work @rebecarubio has done on the instructions

Notes to reviewer

none - run the code and look at everything, I guess?

Related issues

none

…nted/canvass-copy-writing

richardolsson

I haven't looked at all the code yet, but I found that the "instructions" tab (added by #2428) is not working. Just making that note here so that I don't forget it.

richardolsson

I found the time to go through this massive piece of work. Nicely done!

I found some things that I think we should discuss (and some that I think are just mistakes that need to be fixed).

richardolsson · 2024-12-29T08:13:12Z

src/app/beta/orgs/[orgId]/areas/[areaId]/tags/route.ts

@@ -2,7 +2,7 @@ import mongoose from 'mongoose';
 import { notFound } from 'next/navigation';
 import { NextRequest, NextResponse } from 'next/server';

-import { AreaModel } from 'features/areas/models';
+import { AreaModel } from 'features/geography/models';


I don't think I agree with this change. While yes, we have renamed the "Areas" section of the UI to "Geography", I feel like we still have a feature that should be called areas.

Compare this with how the "People" section is where the user fiends the lists/views, profile, joinform and duplicates features. Or how the smartSearch feature can be found in multiple UI sections.

Basically, my point is that there is no 1:1 relationship between a feature and where it goes in the UI. And in the case of this PR, we're not trying to rename the areas feature, but the "Areas" UI page.

richardolsson · 2024-12-29T13:20:29Z

src/features/areaAssignments/components/AreaCard.tsx

-                          },
-                        ]),
+                        linearGradientDef(
+                          messages.overview.progress.headers.households(),


Is this string user-facing? It looks to me like it's an ID and that the "Households visited" string should have never been such a human-readable string

Suggested change

messages.overview.progress.headers.households(),

'householdsVisited'

This hunch is strengthened when I read the nivo documentation on the topic.

richardolsson · 2024-12-29T13:20:48Z

src/features/areaAssignments/components/AreaCard.tsx

@@ -203,12 +224,12 @@ const AreaCard: FC<AreaCardProps> = ({
                                    backgroundColor: (() => {
                                      if (areaData?.area.id !== 'noArea') {
                                        return dataPoint.serieId ===
-                                          'Household Visits'
+                                          messages.overview.progress.headers.households()


Suggested change

messages.overview.progress.headers.households()

'householdsVisited'

richardolsson · 2024-12-29T13:21:14Z

src/features/areaAssignments/components/AreaCard.tsx

                                          ? theme.palette.primary.light
                                          : theme.palette.primary.dark;
                                      } else {
                                        return dataPoint.serieId ===
-                                          'Household Visits'
+                                          messages.overview.progress.headers.households()


Suggested change

messages.overview.progress.headers.households()

'householdsVisited'

richardolsson · 2024-12-29T13:36:12Z

src/features/areaAssignments/components/MetricCard.tsx

@@ -63,7 +63,7 @@ const MetricCard: FC<MetricCardProps> = ({
        <Box display="flex" flexDirection="column" justifyContent="center">
          {metric.kind == 'scale5' && (
            <Typography fontStyle="italic" mb={1}>
-              The canvasser will respond by giving a rating from 1 to 5
+              The areaAssignee will respond by giving a rating from 1 to 5


Missing internationalization.

Also, with regard to what term to use instead of "canvasser", I'm wondering if maybe we should go more neutral and just say "activist" in some places (where the context is enough to explain what kind of activist we're talking about).

It was a concious desicion not to translate things on the "report" page, since it has not been designed and worked on yet.

I agree with your thoughts about calling it "acitvist"!

richardolsson · 2024-12-29T13:53:22Z

src/features/areaAssignments/hooks/useLocations.ts

+import { ZetkinLocation } from '../types';
+import { locationsLoad, locationsLoaded } from '../store';
+
+export default function useLocations(orgId: number) {


Maybe this and some other pure "locations" based things should move to it's own locations feature?

richardolsson · 2024-12-29T14:02:50Z

src/features/geography/l10n/messageIds.ts

@@ -0,0 +1,34 @@
+import { m, makeMessages } from 'core/i18n';
+
+export default makeMessages('feat.geography', {


Seeing this makes me second guess what I said about a "geography" feature. Because the map is indeed part of a geography "feature" rather than an "areas" feature.

I'm beginning to think that we should have all of these features:

Areas (the data, drawing, etc)

Area assignments (everything under the assignment, including it's map etc)

Canvass (the frontend)

Geography (the section and general-purpose map)

richardolsson · 2024-12-29T14:13:09Z

src/features/campaigns/l10n/messageIds.ts

@@ -77,6 +77,9 @@ export default makeMessages('feat.campaigns', {
    heading: m('Feedback and Surveys (none configured)'),
  },
  form: {
+    createAreaAssignment: {
+      defaultQuestion: m('Did you complete the mission?'),


Is this the time to replace "mission", which feels so "big". Or am I the only one who feels that way? I would prefer "assignment" or "task", or something like that.

richardolsson · 2024-12-29T14:25:02Z

src/features/canvass/components/LocationDialog/index.tsx

-import EditPlace from './pages/EditPlace';
-import Place from './pages/Place';
-import Household from './pages/Household';
+import HouseholdVisitPage from './pages/HouseholdVisitPage';


This is a better name. 😊

richardolsson · 2024-12-29T14:38:33Z

src/features/canvass/l10n/messageIds.ts

+
+export default makeMessages('feat.canvass', {
+  default: {
+    assignment: m('Untitled area assignment'),


So far, we have used this as a fallback for assignments that have no title, and we do the same thing in multiple places (which means that this message exists in multiple places, right?).

This is not how it works for most other activities, e.g. call assignments, which must have a title. In those cases, we give it a default title when we create it. I think we should do that with area assignments too.

…t in there

… values on creation, instead of null.

…nted/canvass-copy-writing

ziggabyte added 21 commits December 18, 2024 11:01

Rename "outcomes" to "report".

b66ce96

Rename canvass... to areaAssignment...

853cbdf

Rename from "areas" to "geography"

a78e97d

Localise messages in Geography feature.

235e791

Add <title> to area assignment pages and localise tab labels.

6bcf8ae

Localise the area assignment layout file.

2e19256

Rename "place*" to "location*"

ae57123

Correct name of file.

2ab60a4

Localise overview tab and change structure of messageIds file.

faf80cd

Rename component for clarity.

4736de2

Localise map tab.

4035d17

Localise assignees tab.

1c0fb16

Add default titles to activity list- and overview cards

3d9ed74

Move code for the activist portal into new "canvass" feature folder.

cc8ef86

Localise Canvass feature.

600f3a8

Rename from VisitWizard to HouseholdVisit

80299c0

Add "..Page" to components that were missing it, for consistency.

ef2fc35

Rename components in canvass feature to be called things with Canvass.

d1d5d03

Correct two mistakes in the transaltions.

035f2d8

Merge branch 'main' of github.com:zetkin/app.zetkin.org into undocume…

6c9db8c

…nted/canvass-copy-writing

Change some stray canvassAssId to areaAssId

67a51a6

vercel bot had a problem deploying to Preview – app-zetkin-org December 20, 2024 16:38 Failure

vercel bot deployed to Preview – gen3-storybook December 20, 2024 16:40 View deployment

move map page to correct folder

8a1f4e8

vercel bot deployed to Preview – gen3-storybook December 20, 2024 16:44 View deployment

vercel bot deployed to Preview – app-zetkin-org December 20, 2024 16:50 View deployment

ziggabyte requested a review from richardolsson December 20, 2024 16:50

richardolsson mentioned this pull request Dec 21, 2024

Area assignment: status not shown correctly in activity list or activity overview #2446

Open

richardolsson requested changes Dec 23, 2024

View reviewed changes

Move instructions page to correct route

d0979ec

Merge branch 'main' into undocumented/canvass-copy-writing

559976f

vercel bot deployed to Preview – gen3-storybook December 29, 2024 08:22 View deployment

vercel bot deployed to Preview – app-zetkin-org December 29, 2024 08:31 View deployment

richardolsson requested changes Dec 29, 2024

View reviewed changes

ziggabyte added 6 commits January 7, 2025 16:02

Re-rename feature back to being called "areas".

d9927cb

Use ids for the graphs instead of translations.

fde00c5

Change search-and-replace mistake

1fd1549

Update message.

0a13d45

Create a "geography" feature again, and put the GeographyMap componen…

97ce643

…t in there

Set titles of areas, assignments, locations and households to default…

34fdee5

… values on creation, instead of null.

vercel bot deployed to Preview – gen3-storybook January 7, 2025 15:04 View deployment

Merge branch 'main' of github.com:zetkin/app.zetkin.org into undocume…

3b3c091

…nted/canvass-copy-writing

vercel bot deployed to Preview – app-zetkin-org January 7, 2025 15:17 View deployment

vercel bot deployed to Preview – gen3-storybook January 7, 2025 15:18 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Localise, rename and move everything to do with canvassing #2443

Localise, rename and move everything to do with canvassing #2443

ziggabyte commented Dec 20, 2024

richardolsson left a comment

richardolsson left a comment

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

ziggabyte Jan 7, 2025

ziggabyte Jan 7, 2025

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

richardolsson Dec 29, 2024

	messages.overview.progress.headers.households(),
	'householdsVisited'

		@@ -0,0 +1,34 @@
		import { m, makeMessages } from 'core/i18n';

		export default makeMessages('feat.geography', {

Localise, rename and move everything to do with canvassing #2443

Are you sure you want to change the base?

Localise, rename and move everything to do with canvassing #2443

Conversation

ziggabyte commented Dec 20, 2024

Description

Screenshots

Changes

Notes to reviewer

Related issues

richardolsson left a comment

Choose a reason for hiding this comment

richardolsson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment