ClassBot
|
Size: 3657
Comment: Added Bug & Features
|
Size: 4572
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 7: | Line 7: |
| In an effort to make running a session in the Ubuntu Classroom easier, the Classroom Team has introduced our new bot, ClassBot. ClassBot will automate some of the tasks that need to be done to run a classroom session. | ClassBot was designed by the Classroom Management team to make it easier to run classes in {{{#ubuntu-classroom}}}. It automates several tasks that previously were required to be performed manually. |
| Line 15: | Line 15: |
| question: <question> | QUESTION: <question> |
| Line 17: | Line 17: |
| Where <question> is your actual question. If you don't begin the line with question: ClassBot will not recognize it. | Where <question> is your actual question. If you do not begin the line with ''QUESTION:'', ClassBot will not recognize it, and your question will most likely not get answered. |
| Line 25: | Line 25: |
| The ClassBot will parse from the iCalendar schedule the name of the current session as well as the instructor and change the topic in both {{{#ubuntu-classroom}}} and {{{#ubuntu-classroom-chat}}} to reflect the session that is in progress. This is done automatically with no interaction needed from the instructor. To do this however, your session must be in the iCalendar. If it is not on the iCalendar, please contact a member of the [[https://wiki.ubuntu.com/Classroom/ContactUs|Classroom Management Team]] to get it added. | Using the [[http://people.ubuntu.com/~nhandler/classroom.html|Learning Events Calendar]], ClassBot will update the /topic in {{{#ubuntu-classroom}}} and {{{#ubuntu-classroom-chat}}} to contain information about the current session. Currently, this information includes the session title, names of the instructors, and the event (if present). |
| Line 29: | Line 29: |
| The default setting for any classroom session is now for {{{#ubuntu-classroom}}} to be moderated. This can easily be changed if the instructor does not want the channel moderated. | By default, classroom sessions are not moderated (-m). This means that anyone is able to talk in {{{#ubuntu-classroom}}}. However, if the session is part of an event (if it contains an Event: field on the calendar), it ''will'' be moderated by default (+m). During a moderated session, users are encouraged to join {{{#ubuntu-classroom-chat}}}, where they can ask questions and comment on the current session. |
| Line 31: | Line 31: |
| ==== Granting Voice to Instructor ==== | The ''Moderated:' field in the calendar can be used to change this default behavior. If you are leading a session, please let a member of the Classroom Management Team know whether you would like the channel to be moderated or not moderated, and they will take care of making the necessary changes on the calendar. |
| Line 33: | Line 33: |
| All instructors that are listed for a class on the iCalendar will automatically be granted voice in both {{{#ubuntu-classroom}}} and {{{#ubuntu-classroom-chat}}} at the sessions start time as listed on the iCalendar. The instructors will also automatically be devoiced at the end of the scheduled session. | ==== Voicing Instructors ==== |
| Line 35: | Line 35: |
| = Bot Commands = | All instructors will automatically be voiced in both {{{#ubuntu-classroom}}} and {{{#ubuntu-classroom-chat}}} at the start of their session. They will also automatically be devoiced at the end of the session. |
| Line 37: | Line 37: |
| The following commands can be used to interact with the bot. They can '''ONLY''' be entered via private message, and are only authorized to the current session leader as defined by the iCalendar. | ==== Session Helpers ==== Some instructors prefer to have session helpers to assist with processing questions that are asked in {{{#ubuntu-classroom-chat}}}. Session Helpers have access to the same ClassBot features as Instructors. The only difference between an Instructor and a Session Helper (as far as ClassBot is concerned) is that Session Helpers will not appear the /topic. ==== Slides ==== If your class utilizes the slide feature in [[Lernid]], ClassBot will announce the URL of the slides at the start of the session in both {{{#ubuntu-classroom}}} and {{{#ubuntu-classroom-chat}}}. It will also add a link to the slides in the /topic of those channels. = Instructor Commands = The following commands can be used by instructors (or session helpers) to interact with the bot. They must be sent via private message to ClassBot. |
| Line 43: | Line 53: |
| Issuing this command to ClassBot will provide a reply from the bot that shows the next question in the queue. The instructor can then accept the question !yes or reject the question !no [comment]. | Issuing this command to ClassBot will allow you to review the next question in the queue. You can then accept the question with !yes or reject the question with !no [comment]. |
| Line 47: | Line 57: |
| Replying !yes or !y after ClassBot has shown the question for review will send the question to {{{#ubuntu-classroom}}} for the instructor to answer. | Replying !yes or !y after ClassBot has shown you a question for review (after doing !question) will post the question to {{{#ubuntu-classroom}}} for everyone to see. You can then proceed to answer the quesiton. |
| Line 51: | Line 61: |
| Replying !no or !n will reject a question that has been asked. If you reply with a comment (!no this is not a support class. Please join #ubuntu for support) ClassBot will send your comment to the user in {{{#ubuntu-classroom-chat}}}. | Replying !no or !n after ClassBot has shown you a question for review (after doing !question) will reject the question. If you include an optional comment, (i.e.: !no This is not a support class. Please join #ubuntu for support.) ClassBot will send your comment to the user in {{{#ubuntu-classroom-chat}}}. |
| Line 53: | Line 63: |
| Rejections can be done if: | A question can be rejected if: |
| Line 55: | Line 65: |
| * the question is not relevant to the session | * the question is not relevant to the current session |
| Line 58: | Line 68: |
| == #ubuntu-classroom moderation == | |
| Line 60: | Line 69: |
| By default, and time a session is scheduled in {{{#ubuntu-classroom}}}, the channel will set to moderated by ClassBot. This can easily be changed by the instructor(s) listed in the iCalendar event. | == #ubuntu-classroom Moderation == Depending on the type of session you are running, ClassBot may or may not moderate {{{#ubuntu-classroom}}} by default. You can easily change if the channel is moderated or not. |
| Line 64: | Line 75: |
| If you do not want your class to be moderated, then PM ClassBot with !moderate or !m and it will toggle off moderation of {{{#ubuntu-classroom}}}. If you decide that you want the class to be moderated again, just PM !moderate or !m to ClassBot again. | The !moderated command can be used to quickly and easily toggle whether {{{#ubuntu-classroom}}} is moderated (+m) or not (-m). |
|
Ubuntu Classroom |
|
Communication |
|
Team Information |
|
Teach a Class |
As of 2014 the Ubuntu Classroom project is no longer active. |
ClassBot was designed by the Classroom Management team to make it easier to run classes in #ubuntu-classroom. It automates several tasks that previously were required to be performed manually.
User Interaction
Asking Question
To ask a question, you need to be in #ubuntu-classroom-chat and ask your question in the following format:
QUESTION: <question>
Where <question> is your actual question. If you do not begin the line with QUESTION:, ClassBot will not recognize it, and your question will most likely not get answered.
Instructor Interaction
Automatic Tasks
Channel Topic
Using the Learning Events Calendar, ClassBot will update the /topic in #ubuntu-classroom and #ubuntu-classroom-chat to contain information about the current session. Currently, this information includes the session title, names of the instructors, and the event (if present).
Channel Moderation
By default, classroom sessions are not moderated (-m). This means that anyone is able to talk in #ubuntu-classroom. However, if the session is part of an event (if it contains an Event: field on the calendar), it will be moderated by default (+m). During a moderated session, users are encouraged to join #ubuntu-classroom-chat, where they can ask questions and comment on the current session.
The Moderated:' field in the calendar can be used to change this default behavior. If you are leading a session, please let a member of the Classroom Management Team know whether you would like the channel to be moderated or not moderated, and they will take care of making the necessary changes on the calendar.
All instructors will automatically be voiced in both #ubuntu-classroom and #ubuntu-classroom-chat at the start of their session. They will also automatically be devoiced at the end of the session.
Some instructors prefer to have session helpers to assist with processing questions that are asked in #ubuntu-classroom-chat. Session Helpers have access to the same ClassBot features as Instructors. The only difference between an Instructor and a Session Helper (as far as ClassBot is concerned) is that Session Helpers will not appear the /topic.
If your class utilizes the slide feature in Lernid, ClassBot will announce the URL of the slides at the start of the session in both #ubuntu-classroom and #ubuntu-classroom-chat. It will also add a link to the slides in the /topic of those channels.
The following commands can be used by instructors (or session helpers) to interact with the bot. They must be sent via private message to ClassBot.
Issuing this command to ClassBot will allow you to review the next question in the queue. You can then accept the question with !yes or reject the question with !no [comment].
Replying !yes or !y after ClassBot has shown you a question for review (after doing !question) will post the question to #ubuntu-classroom for everyone to see. You can then proceed to answer the quesiton.
Replying !no or !n after ClassBot has shown you a question for review (after doing !question) will reject the question. If you include an optional comment, (i.e.: !no This is not a support class. Please join #ubuntu for support.) ClassBot will send your comment to the user in #ubuntu-classroom-chat. A question can be rejected if:
Depending on the type of session you are running, ClassBot may or may not moderate #ubuntu-classroom by default. You can easily change if the channel is moderated or not.
The !moderated command can be used to quickly and easily toggle whether #ubuntu-classroom is moderated (+m) or not (-m).
If you run into any issues with ClassBot, or have any suggestions on ways to improve it, please file a bug! Voicing Instructors
Session Helpers
Slides
Instructor Commands
Question Handling
!question / !q
!yes / !y
!no / !n [comment]
#ubuntu-classroom Moderation
!moderate / !m
Bugs and Feature Requests
Classroom/ClassBot (last edited 2012-07-05 16:15:02 by lyz)