Skip to content

Commit 2c6ccd5

Browse files
samjjackosamjjacko
authored
Merge pull request #154 from codersforcauses/issue-98-showcases_documentation
Issue 98 showcases documentation
2 parents 51e872d + 0730c2a commit 2c6ccd5

4 files changed

Lines changed: 100 additions & 11 deletions

File tree

‎client/documentation/admin-dashboard/committee.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
## Committee Members
22

3-
Profiles of the Committee Members of the club that are displayed on the about page.
3+
URL: `/admin/game_dev/committee/add/`
4+
5+
Profiles of the Committee Members of the club that are displayed on the about page `/about`.
6+
7+
## Prerequisites
8+
9+
As a committee member is also a member of the club, you must construct a member first via `/admin/game_dev/member/add/`. Back on the committee page, you can find a specific member (e.g. the one you just created) by clicking the magnifying glass icon next to the `Id` input box.
410

511
## Fields
612

713
**Id:** Required and unique field for the club member that is on the committee. It is an integer field that corresponds to the raw integer id of a row in the Member table, as a Foreign Key if you know databases.
814

915
**Role:** Required and unique field for the specific role in the committee that this member has. It is something known as an Enum (Enumeration), which has a discrete number of custom choices. You can choose from 'President', 'Vice President', 'Secretary', 'Treasurer', 'Marketing', 'Events OCM', 'Projects OCM', and 'Fresher Rep'. Since they must be unique, you can only have 8 objects in the Committee table at a time for now. This can definitely be changed in the future when the committee grows.
10-
11-
## Other Notes
12-
13-
Before making a Committee object in the Committee table, you must make a Member object for the person that's on the committee and then link it through the id (just to clarify)

‎client/documentation/admin-dashboard/games.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
## Games
22

3+
URL: `/admin/game_dev/game/`
34
Pages for games can be added and edited at the row 'Game' of the GAME_DEV section on the main admin page.
45

56
### Fields
67

78
**Name:** Required field for the game's name. A character field (includes letters, numbers and symbols) of maximum length 200 characters.
89

9-
**Descripiton:** Required field for the game's description. A text field.
10+
**Description:** Required field for the game's description. A text field.
1011

1112
**Completion:** Required field for the game's completion. A multichoice option field with four options including:
12-
- "Work in progress (Unplayable)"
13-
- "Playable - In Development"
14-
- "Beta - Stable but not Final"
15-
- "Completed"
13+
14+
- "Work in progress (Unplayable)"
15+
- "Playable - In Development"
16+
- "Beta - Stable but not Final"
17+
- "Completed"
1618

1719
**Active:** Required field for if the game is continued to be being worked on. A boolean field.
1820

@@ -28,4 +30,5 @@ Pages for games can be added and edited at the row 'Game' of the GAME_DEV sectio
2830

2931
**Itch Game Width:** This field is required if the playable field ID is non null. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "width=" and in the page source is found after "data-width=".
3032

31-
**Itch Game Height:** This field is required if the playable field ID is non null. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "height=" and in the page source is found after "data-height=".
33+
**Itch Game Height:** This field is required if the playable field ID is non null. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "height=" and in the page source is found after "data-height=".
34+

‎client/documentation/admin-dashboard/members.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
## Member Profiles
22

3+
URL: `/admin/game_dev/member/add/`
34
Profiles of club members can be added and edited at the row 'Member' of the GAME_DEV section on the main admin page.
45

56
### Fields

‎client/documentation/admin-dashboard/showcase.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
## Game Showcase
2+
URL: `/admin/game_dev/gameshowcase/add/`
3+
The Game Showcase page is managed by administrators to highlight outstanding individual games. It serves as the featured section of the game library (see `/games`).
4+
5+
## Prerequisites
6+
7+
1. **Add a Game**
8+
9+
- Path: `/admin/game_dev/game/add/`
10+
- Required fields: name, description, completion status, host URL, thumbnail, event, etc.
11+
12+
2. **Add Game Contributors**
13+
- Path: `/admin/game_dev/gamecontributor/add/`
14+
- Link club members to individual games. Each contributor must first be created in the `/admin/game_dev/member/` member panel.
15+
16+
## Add Game Showcase
17+
18+
1. Navigate to: `/admin/game_dev/gameshowcase/add/`
19+
2. Use the search function to find the desired game, then click the game ID to populate the value.
20+
3. Enter the committee's recommendation in the "Description" field.
21+
4. Save your changes and review the showcase page to ensure the content is correct.
22+
23+
## Page Elements Maintenance
24+
25+
- **Game Title**
26+
27+
- Edit at: `/admin/game_dev/game/`
28+
29+
- **Recommendation (Committee Advice)**
30+
31+
- Edit at: `/admin/game_dev/gameshowcase/`, under the field "Description"
32+
- This recommendation appears directly under the game title as advice from the committee.
33+
34+
- **Game Description**
35+
36+
- Edit at: `/admin/game_dev/game/`
37+
- The description is shown below the cover image and contributor section, and matches the content on the individual game page.
38+
39+
- **Cover Image**
40+
- Uses the thumbnail uploaded when adding the game.
41+
- Edit at: `/admin/game_dev/game/`
42+
43+
## Art Showcase
44+
45+
The Art Showcase page is managed by administrators to highlight outstanding individual artworks. It serves as the featured section of the art library.
46+
47+
## Prerequisites
48+
49+
1. **Add an Art Object**
50+
51+
- Path: `/admin/game_dev/art/add/`
52+
- Required fields: name, description, source_game, media, active
53+
54+
2. **Add Art Contributors**
55+
- Path: `/admin/game_dev/artcontributor/add/`
56+
- Link club members to individual artworks. Each contributor must first be created in the `/admin/game_dev/member/` member panel.
57+
58+
## Add Art Showcase
59+
60+
1. Navigate to: `/admin/game_dev/artshowcase/add/`
61+
2. Use the search function to find the desired art object, then click the art ID to populate the value.
62+
3. Enter the committee's recommendation in the "Description" field.
63+
4. Save your changes and review the showcase page to ensure the content is correct.
64+
65+
## Page Elements Maintenance
66+
67+
- **Art Name**
68+
69+
- Edit at: `/admin/game_dev/art/`
70+
71+
- **Recommendation (Committee Advice)**
72+
73+
- Edit at: `/admin/game_dev/artshowcase/`, under the field "Description"
74+
- This recommendation appears directly under the art name as advice from the committee.
75+
76+
- **Art Description**
77+
78+
- Edit at: `/admin/game_dev/art/`
79+
80+
- **Media**
81+
- Uses the media uploaded when adding the art.
82+
- Edit at: `/admin/game_dev/art/`
83+

0 commit comments

Comments
 (0)