Skip to content

Commit 8f883ca

Browse files
Outline all person identifiers and their validation
1 parent eab084e commit 8f883ca

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

ynr/apps/people/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,25 @@ standing in.
1010
Thing like their political party should be stored on the _candidacy_.
1111
This is currently represented as a `Membership` in the `popolo` app.
1212

13+
# Person Identifiers
14+
15+
`PersonIdentifiers` are used to store contact information and online presence for a candidate. Users can add/edit these identifiers in the person update form. The following fields are available in the `PersonIdentifier` model with the corresponding form labels and accepted formats:
16+
```
17+
email = "Email": Accepts a valid email address; raises an exception if the email is submitted with an invalid format. The email address must be unique.
18+
facebook_page_url = "Facebook Page": Accepts a valid URL but does not currently validate the domain.
19+
facebook_personal_url = "Facebook Personal": Same as above.
20+
homepage_url = "Homepage": Accepts a valid URL
21+
blog_url = "Blog": Accepts a valid URL
22+
linkedin_url = "Linkedin": Accepts a valid URL; does not currently validate the domain or the format of the username.
23+
party_ppc_page_url = "Party Candidate Page": Accepts a valid URL
24+
twitter_username = "Twitter": Accepts a Twitter username and returns the full Twitter URL.No longer validates the username actually exists.
25+
mastodon_username = "Mastodon": Accepts and returns a valid Mastodon URL and validates the domain and username.
26+
wikipedia_url = "Wikipedia": Accepts a valid URL; does not currently validate the domain.
27+
wikidata_id = "Wikidata": Accepts a valid Wikidata ID
28+
youtube_profile = "YouTube Profile": Accepts a valid URL; does not currently validate the domain.
29+
instagram_url = "Instagram Profile": Accepts and returns a valid Instagram URL and validates the domain and format of the username.
30+
blue_sky_url = "Bluesky URL": Accepts and returns a valid URL
31+
threads_url = "Threads URL": Accepts and returns a valid URL
32+
tiktok_url = "TikTok URL": Accepts and returns a valid URL
33+
other_url = "Other URL": Accepts and returns a valid URL
34+
```

0 commit comments

Comments
 (0)