Skip to content

Commit d53bf10

Browse files
authored
Merge pull request #121 from codersforcauses/issue-94-members_documentation
Issue 94 members documentation
2 parents 3243dc4 + e3ab10b commit d53bf10

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Member Profiles
2+
3+
Profiles of club members can be added and edited at the row 'Member' of the GAME_DEV section on the main admin page.
4+
5+
### Fields
6+
7+
**Name:** Required field for the member's name. A character field (includes letters, numbers and symbols) of maximum length 200 characters.
8+
9+
**Active:** Checkbox to represent whether a member is an active participant in the club. If the checkbox is not ticked then the member's profile will not be displayed on the website.
10+
11+
**Profile Picture:** Optional field to upload a profile picture. Must be an image file, and will display best if the image is at least 128 by 128 px in size. If no profile picture is provided then the member's initials will be displayed instead.
12+
13+
**About:** Optional field for a bio. A character field of maximum length 256 characters.
14+
15+
**Pronouns:** Optional field for the member's pronouns. A character field of maximum length 20 characters.
16+
17+
**Social media links:** Optional section to display links to the member's social media profiles. Requires a link to the profile (character field of maximum length 2083) and, optionally, the profile username (character field of maximum length 200). If a username is not supplied then only a social media icon will be displayed with the link attached, otherwise the username will be placed next to the relevant icon. The type of icon to be displayed (e.g. instagram, linkedin, generic link) is inferred from the social media link provided.

0 commit comments

Comments
 (0)