Coursemology · adi-herwana-nus · Feb 17, 2025 · Feb 17, 2025 · Feb 17, 2025 · Feb 17, 2025
diff --git a/README.md b/README.md
@@ -23,6 +23,33 @@ $ yarn build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
+The pages can be viewed locally using the command:
+
+```
+$ yarn serve
+```
+
+#### Viewing and Editing Translations
+
+To view a translated version of the docs, run the above command with the `--locale` flag containing the language you wish to view (e.g. `zh`)
+
+To create a new language translation, run
+```
+LOCALE=zh yarn write-translations
+```
+
+Translatable text in React components must be contained within `<Translate/>` elements for Docusaurus to be able to find and match them with translated versions correctly. Markdown files (`*.md` and `*.mdx`) files have to be translated as a whole. 
+
+The above command will copy most of the default (English) text, they should be manually replaced with the properly translated versions.
+
+First, copy the files to the proper translation directory
+```
+rsync -avm  --include='{*.md,*.mdx}' --exclude='!{*.md,*.mdx}' --delete docs/* i18n/zh/docusaurus-plugin-content-docs/current
+```
+
+then replace the contents of each page with the appropriate translated versions.
+
+Due to [Docusaurus limitations](https://github.com/facebook/docusaurus/issues/7377), when using `yarn start`, only one locale can be supported at a time, and the language dropdown will not work locally. To test the languages side-by-side, run `yarn build` followed by `yarn serve`.
 
 ### Deployment
 

diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/authors.yml b/blog/authors.yml
diff --git a/docs/instructors/1-setup/A-create-account/index.md b/docs/instructors/1-setup/A-create-account/index.md
@@ -0,0 +1,24 @@
+---
+sidebar_position: 1
+slug: /instructor-guide/setup/create-account
+title: 1a. Creating your Coursemology account
+sidebar_label: 1a. Create Account
+---
+
+To register as a user:
+  1. Click on **Create an account**.
+  2. Enter your account details.
+  3. Click **Sign up**.
+
+You should see a notification informing you that an email has been sent to your email account.
+
+![1A-1](/img/instructors/1A-1.gif)
+
+To confirm your account:
+  1. Log into your email
+  2. Click on the confirmation link sent to you
+
+![1A-2](/img/instructors/1A-2.gif)
+
+You may then proceed to sign in.
+
diff --git a/docs/instructors/1-setup/B-account-settings/index.md b/docs/instructors/1-setup/B-account-settings/index.md
@@ -0,0 +1,30 @@
+---
+sidebar_position: 2
+slug: /instructor-guide/setup/account-settings
+title: 1b. Manage your account settings
+sidebar_label: 1b. Account Settings
+---
+
+Sign in to Coursemology.
+
+![1B-1](/img/instructors/1B-1.gif)
+
+
+:::info
+
+New sign-ups are set to students by default.
+
+As a student, you cannot create a course! You need to be an instructor.
+
+You can request to become one by clicking on the **Request to be an instructor** button.
+
+![1B-3](/img/instructors/1B-3.png)
+
+:::
+
+To update your account settings:
+  * Click on your profile picture at the top right corner of the page. 
+  * Choose **Account settings** from the drop down.
+  * You may then update your display name, upload profile picture, or change your password.
+
+![1B-2](/img/instructors/1B-2.gif)
diff --git a/docs/instructors/1-setup/_category_.json b/docs/instructors/1-setup/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "1. Setup",
+  "position": 1
+}
diff --git a/docs/instructors/2-coursemology-admin-settings/index.md b/docs/instructors/2-coursemology-admin-settings/index.md
@@ -0,0 +1,41 @@
+---
+slug: /instructor-guide/coursemology/settings
+title: 2. Admin Settings
+---
+
+At least one of the instructors should be the instance admin of your Coursemology instance.
+
+The admin has full-access to the Coursemology instance, whereas Instructors can only create a new course.
+
+* To access the admin panel, click on your **profile picture > Instance Admin Panel**
+<br/><br/>
+* To upgrade your other users to an Instructor:
+  1. Click on **Users** tab
+  2. Change role of the user to **Instructor** from the drop down. 
+  3. There should be a notification confirming that the user was updated.
+<br/><br/>
+* To delete a course:
+  1. Click on **Courses** tab
+  2. Under **Actions**, click on the trash can icon to delete. 
+  3. You will be prompted to confirm deletion.
+
+  <br/>
+
+  :::warning
+
+  Deletion of courses is **IRREVERSIBLE.** <br/>
+  Make sure you have downloaded everything you still need from the course before confirming.
+
+  :::
+<br/><br/>
+* To activate / deactivate components in courses across the instance:
+  1. Click on **Components** tab
+  2. You may toggle on or off the components accordingly. 
+  3. There should be a notification confirming that the change was updated.
+
+![2A-1](/img/instructors/2A-1.gif)
+
+* To approve / reject role requests:
+  1. Click on **Role Requests** tab
+  2. Under **Actions**, you may choose to **approve**, **reject with message**, or **reject** requests.
+![2A-2](/img/instructors/2A-2.png)
diff --git a/docs/instructors/3-course/A-create-course/index.md b/docs/instructors/3-course/A-create-course/index.md
@@ -0,0 +1,19 @@
+---
+slug: /instructor-guide/course/create-course
+title: 3a. Creating a course
+sidebar_label: 3a. Create Course
+---
+
+As an instructor, you now can create a new course!
+  1. Click on **New Course**
+  2. Enter the details of the course and **Submit**
+
+![3a-1](/img/instructors/3A-1.gif)
+
+To modify course settings, click on **Course Settings** on the sidebar
+
+![3A-2](/img/instructors/3A-2.gif)
+
+Be careful not to delete the course by accident!
+
+![3A-3](/img/instructors/3A-3.png)
diff --git a/docs/instructors/3-course/B-add-manage-users/index.md b/docs/instructors/3-course/B-add-manage-users/index.md
@@ -0,0 +1,44 @@
+---
+slug: /instructor-guide/course/add-manage-users
+title: 3b. Add / Manage Users
+---
+
+You may perform the following actions on **Manage Users** page.
+
+- [Invite Users Individually](#invite-users-individually)
+- [Invite Users From File](#invite-users-from-file)
+- [Upgrade User Roles](#upgrade-user-roles)
+
+#### Invite Users Individually
+
+1. Click on **Manage Users** on the sidebar.
+2. Click on **Invite Users** tab.
+3. Input the details of your users.
+4. Click on **Add Row** to input more entries.
+5. Finally, click **Invite All Users** to send an invitation.
+
+![3B-1](/img/instructors/3B-1.png)
+
+Invited users will receive the following email.
+
+![3B-2](/img/instructors/3B-2.png)
+
+#### Invite Users From File
+
+1. Click on **Invite from file**.
+2. Download the **Template File**.
+3. Enter the user details (only name and email is compulsory, the other fields can be left blank).
+4. Save the file in **CSV** file format and upload it.
+
+You will see the users under **Invitations** tab.
+
+![3B-3](/img/instructors/3B-3.gif)
+
+#### Upgrade User Roles
+
+To upgrade the user to **Teaching Assistant**, **Manager**, or **Owner**:
+
+1. Click on **Staff** tab.
+2. Select the corresponding role for that user via the drop-down. The changes will be saved automatically.
+
+![3B-4](/img/instructors/3B-4.png)
diff --git a/docs/instructors/3-course/C-components/index.md b/docs/instructors/3-course/C-components/index.md
@@ -0,0 +1,22 @@
+---
+slug: /instructor-guide/course/components
+title: 3c. Components Settings
+---
+
+
+Turning off features that were not used will make the side navigation bar neater.
+You may do so on the Components page.
+
+The components can be classified as follows.
+
+**Learning and assessment**
+![3C-1](/img/instructors/3C-1.png)
+
+**Student and instructor interaction**
+![3C-2](/img/instructors/3C-2.png)
+
+**Gamification features**
+![3C-3](/img/instructors/3C-3.png)
+
+**Other Admin features**
+![3C-4](/img/instructors/3C-4.png)
diff --git a/docs/instructors/3-course/_category_.json b/docs/instructors/3-course/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "3. Course",
+  "position": 3
+}
diff --git a/docs/instructors/4-assessments/A-create-assessment/index.md b/docs/instructors/4-assessments/A-create-assessment/index.md
@@ -0,0 +1,22 @@
+---
+title: 4a. Create an Assessment
+slug: /instructor-guide/assessments/create-assessment
+sidebar_label: 4a. Create Assessments
+---
+
+To create a new assessment:
+  1. Click on **Assessments** on the side navigation.
+  2. Click on **New Assessment**.
+  3. Input the **Title** and **Starts at** (compulsory) and other details of your choosing (optional)
+  4. Click **Create As Draft**
+
+![4A-1](/img/instructors/4A-1.gif)
+
+To publish your assessment (or to edit the settings):
+  1. Navigate to the respective assessment, and click on the **Edit** icon.
+  2. Select **Published**.
+  3. You may change other settings (e.g. set end time). Finally, click **Save**.
+  3. The assessment will now be made visible to students.
+
+![4A-2](/img/instructors/4A-2.gif)
+
diff --git a/docs/instructors/4-assessments/B-create-question/index.md b/docs/instructors/4-assessments/B-create-question/index.md
@@ -0,0 +1,19 @@
+---
+slug: /instructor-guide/assessments/create-question
+title: 4b. Create MCQ / MRQ
+---
+
+To create MCQs:
+  1. Navigate to the assessment
+  2. Click **New Question** and select **MCQ** in the dropdown
+  3. Fill in the question under **Description**.
+  4. Give the question a grade (e.g. 1 mark)
+  5. Fill in the corresponding choices (make sure you check a correct choice as the answer!)
+  4. When done, click **Save Changes**
+
+![4B-1](/img/instructors/4B-1.gif)
+
+Creating MRQ is similar, except that you should check more than 1 correct choice for MRQ.
+
+You may also convert the MCQ to MRQ by clicking on the **Convert to MRQ** button at the bottom right. You may do likewise for MRQ to MCQ.
+![4B-2](/img/instructors/4B-2.png)