Skip to content

Latest commit

 

History

History
148 lines (88 loc) · 7.69 KB

LaCE-onboarding-guide.md

File metadata and controls

148 lines (88 loc) · 7.69 KB

This page will help you solve common queries that you may face while working on LaCE issues. If you do not get a satisfactory explanation from this page, feel free to mention your query in the issue thread that you are working on or else make a discussion regarding this in Dicussions. If you feel that your query can be a valid addition to this page, then make sure to create a new issue here addressing your question.

How to perform common operations on your local server

Index Common Queries
1. Creating a Topic
2. Creating a Skill
3. Generating data on localhost
4. Creating a classroom

1. Creating a Topic

  • To create a new topic, we first navigate to the Topics and Skill Dashboard and select the CREATE TOPIC option. To do so, you can take a look at this guide
  • A modal will open up with necessary details of the topic that are to be filled such as topic name, topic thumbnail, etc.

Screenshot of topic modal

  • Once this is done, the topic is created and you will be redirected to the topic editor page.

Screenshot of topic editor

  • In the main editor tab, we will be able to see the errors that are preventing the topic from being published.

Screenshot of topic editor warnings

  • This tab has 4 main sections:

    • Details: Information related to the topic
    • Subtopics section: Subtopics and skills associated with the topic are listed.

    Screenshot of subtopics section

    • Diagnostic Tests: Add skills that will be used to generate the diagnostic test that determines whether to recommend this topic to new learners. For a skill to qualify for this, it must have at least 3 questions and be assigned to that topic.

    Screenshot of diagnostic test section

    • Canonical stories: In this section, the stories belonging to the topic are listed.

    Screenshot of canonical stories section

2. Creating a Skill

NOTE: For a skill to be visible on the practice tab of a topic, it must have at least 10 questions associated with it.

  • A skill can be directly created from the topic editor by clicking the ADD SKILL button under Subtopics section of the topic editor. But in this case, the skill will be automatically assigned to that topic.
  • A skill can also be created from the Topic and Skill Dashboard as well but it will not be assigned to any topic.
  • On clicking the ADD SKILL option a modal will pop up with necessary details of the skill.

Screenshot of creating a skill

  • Once this is done, the skill is created and you will be redirected to the skill editor page

  • The main skill editor section has the following part:

    • Details

    Screenshot of skill details section

    • Worked example

    Screenshot of worked examples section

    • Misconceptions: Common errors that users may have and their explanations. The creator is given the option to enforce the misconception on all question within the skill as seen in the image below.

    Screenshot of skill misconceptions section

    • Pre-requisite Skills: Skills that are to be completed before attempting the current skill. The prerequisite skills can be filtered by topic, subtopic and by title of the skill.

    Screenshot of pre-requisite skill section

    • Rubrics: This section of the skill helps question creators make questions under a certain rubric.

    Screenshot of skill rubrics section

  • The questions section lists the questions in the skill:

    • To add a new question, select the ADD QUESTION option

    • In the question editor, there are 5 sections:

      • Difficulty

      Screenshot of question difficulty section

      • Problem

      Screenshot of problem section

      • Interaction

      Screenshot of interaction and answers and responses sections

      • Answers and Responses (This section can be seen in the image above)
      • Hints

      Screenshot of question hint section

    • Once all these sections are filled, the question can be saved.

    Screenshot of clickable save button

3. Generating data on localhost

  • To generate data, we must first navigate to the admin page.

Admin-Page

We will automatically be redirected to the ACTIVITIES tab.

  • This tab will have several sections:
  • Reload a single exploration: This section has preloaded explorations. These can be loaded onto your local server by clicking the Reload button for each of them.

Activity-Tab

  • Generate dummy explorations: Along with the option to generate dummy explorations (with no content), we can also publish a certain number of them.

Dummy-Exploration

  • Reload a single collection: This section has preloaded collections.

Reload-Single-Collection

  • Load dummy new structures data: This section provides a combination of topics, skills, stories and exploration.

Dummy-New-Structure-Data

  • Generate dummy skill with questions

Dummy-Skill-with-Questions

  • Generate a dummy math classroom

Dummy-Math-Classroom

4. Creating a Classroom

  • We must first navigate to the CONFIG tab in the admin page.
  • In this tab, there is a section The details for each classroom page. in which you will find a default math classroom that is filled out.

ClassRoom-Page-Detail

  • It has details about the classroom:
    • Name
    • URL Fragment
    • topic list intro
    • topci ids: The topic ids that should be included in the classroom are listed here. We can add to this by clicking on the Add element option.
  • More classrooms can be generated by clicking on the Add element option beneath this section.
  • Once the classroom details have been filled, to complete the process we must save changes by clicking the Save button at the buttom left corner of the CONFIG tab.

Save-Button

  • If the classroom has been created successfully you will be able to see a message Data successfully saved at the bottom right corner of the screen.

Data-Saved-Succesfully

  • The newly created classroom will be visible in the Home tab of the learner dashboard page or we can directly access the classroom from the link localhost:8181/learn/<classroom-url-fragment>.