Merge pull request #140 from codersforcauses/issue-95-committee_documentation

Issue 95 committee documentation

Author: laurenpudz

client/documentation/admin-dashboard/committee.md

@@ -0,0 +1,13 @@
+## Committee Members
+
+Profiles of the Committee Members of the club that are displayed on the about page.
+
+## Fields
+
+**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.
+
+**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.
+
+## Other Notes
+
+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/pages/about-committee.md

@@ -0,0 +1,11 @@
+## About/Committee Page
+
+Has a description of the club, it's aim's etc, along with a big feature photo, intended to be a group photo of the committee or a big event? Then below is a display of all the current committee members of the club, showing name, role and pronouns.
+
+## Hardcoded content to be modified by committee members
+
+The club description and feature photo are the only things hardcoded into the website's front-end. Starting from the root directory of this website's source, this code to modify can be found in /client/src/pages/about.tsx
+
+## Other Notes
+
+The Committee Members are always displayed in the same order on the about page, which is the order mentioned in admin-dashboard/committee.md. If a certain Committee object can't be retreived, a placeholder Committee Member portrait will be displayed to maintain the same order.

client/src/pages/about.tsx

@@ -30,20 +30,24 @@ export default function AboutPage() {
             <div className="mb-6 w-full border-t" aria-hidden="true" />
             <div className="space-y-4 font-sans text-base leading-relaxed text-white md:text-lg">
               <p>
-                Description of the clubs aims, why it exists, its mission, etc
-                etc. Second paragraph here, a second paragraph would be pretty
-                cool. The more info the better yippee!!
-              </p>
-              <p>
-                Lorem ipsum dolor such and such I can&apos;t remember the rest.
+                {/*>>Hardcoded description of the club to be altered<<*/}
+                Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
+                eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
+                enim ad minim veniam, quis nostrud exercitation ullamco laboris
+                nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor
+                in reprehenderit in voluptate velit esse cillum dolore eu fugiat
+                nulla pariatur.
+                {/*>>Hardcoded description of the club to be altered<<*/}
               </p>
             </div>
           </div>
           <div className="relative aspect-[4/3] w-full flex-shrink-0 overflow-hidden rounded-2xl bg-light_2 md:w-96 lg:w-[32rem]">
             <div className="flex h-full w-full items-center justify-center">
               <Image
+                /*>>Hardcoded feature image to be altered.<<*/
                 src="/landing_placeholder.png"
-                alt="/landing_placeholder.png"
+                /*>>Description of feature image - alter this alongside the feature image.<<*/
+                alt="Placeholder Picture"
                 fill={true}
               />
             </div>
@@ -64,7 +68,7 @@ export default function AboutPage() {
       <div className="relative h-[8.75rem] w-[8.25rem] overflow-hidden">
         <Image
           src={profilePic === null ? "/landing_placeholder.png" : profilePic}
-          alt="/landing_placeholder.png"
+          alt="Placeholder Picture"
           fill
           className="object-cover object-center"
         />
@@ -134,9 +138,7 @@ export default function AboutPage() {
       </main>
     );
   } else {
-    for (let i = 0; i < 8; i++) {
-      committeeList.push(committee[i]);
-    }
+    committeeList.push(...committee.slice(0, 8));
   }
 
   return (