Documentation update for discussions including sidebar and notifications #1306
Conversation
ayub02
changed the title
ayub02
changed the title
|
Hi @ayub02 I'll review this more tomorrow! I did take a look at the images and I don't think the light purple arrows are enough for a callout (they're a bit hard to see). We recommend using red boxes (see https://docs.openedx.org/en/latest/documentors/references/templates/doc_quickstart_template.html#how-to-document-template-section:
|
There was a problem hiding this comment.
I didn't make a comment on every alt text, but the alt text should be reviewed to ensure they are being helpful and descriptive for people who cannot view the image.
Additionally I would fill out the maintenance table for each page - with either your name or "Docs WG" and the release ("Ulmo")
| 1. **Activity notifications**: Cover all activity related to your own posts, responses, and followed threads. | ||
| 2. **New question posts**: Alerts you when someone creates a new question type post in your course. | ||
| 3. **New discussion posts**: Alerts you when someone creates a new discussion type post. | ||
| 4. **New posts from instructors**: Notifies you when an instructor or staff member creates a post. |
There was a problem hiding this comment.
I would use consistent language (probably "Notifies" in all four bullets instead of "Cover", "Alerts", and "Notifies")
I'm also a little confused. If I have (1) selected, does that include the notifications from (2), (3), and (4)? How do 2/3/4 relate to 1?
| 3. **New discussion posts**: Alerts you when someone creates a new discussion type post. | ||
| 4. **New posts from instructors**: Notifies you when an instructor or staff member creates a post. | ||
|
|
||
| The tables below shows who receives each notification by default. |
There was a problem hiding this comment.
The tables are a little confusing to me. How do the two tables relate to the four preferences above?
| .. tip:: | ||
|
|
||
| **Activity notifications** cover almost all events in threads and responses you create or follow. | ||
| You can turn them off completely or change only the email frequency in the **Preferences Center**. |
There was a problem hiding this comment.
| You can turn them off completely or change only the email frequency in the **Preferences Center**. | |
| You can turn them off completely or change the email frequency in the **Preferences Center**. |
| **Activity notifications** cover almost all events in threads and responses you create or follow. | ||
| You can turn them off completely or change only the email frequency in the **Preferences Center**. | ||
|
|
||
|
|
There was a problem hiding this comment.
We add a .. seealso:: table to pages to reference related articles, this helps navigate
| Navigating the Discussions page | ||
| ******************************** | ||
|
|
||
| When you open the Discussions tab in your course, you see four tabs at the top, as shown in the image below. |
There was a problem hiding this comment.
Add the image right here, before the bullets. It is clearer.
| ************************* | ||
|
|
||
| You can add to an existing conversation by writing a response or a comment. | ||
|
|
There was a problem hiding this comment.
Again I'd add the image here
| ****************************** | ||
|
|
||
| Moderators help maintain a respectful learning environment. | ||
| They can close posts to prevent new replies or edit or delete content. |
There was a problem hiding this comment.
| They can close posts to prevent new replies or edit or delete content. | |
| They can close posts to prevent new replies, or edit or delete content. |
| A closed post shows a lock icon at the bottom right corner. | ||
| If you are the author, a banner appears at the top explaining why the post was closed. | ||
|
|
||
| Moderators may close posts that are off-topic, duplicates, resolved, or related to graded assignments or exams. |
There was a problem hiding this comment.
| Moderators may close posts that are off-topic, duplicates, resolved, or related to graded assignments or exams. | |
| Moderators might close posts for reasons that include: they are off-topic, duplicates, resolved, or related to graded assignments or exams. |
I wouldn't assume these are the only reasons that a course team might have - or that they'll actually do any of these things.
| Post edited by a moderator showing an edit reason banner. | ||
|
|
||
| ****************************** | ||
| See also |
There was a problem hiding this comment.
Use a .. seealso:: table, rather than a heading.
| ****************************** | ||
|
|
||
| - :ref:`Staying Updated with Notifications <staying-updated-with-notifications>` | ||
| - :ref:`Finding and Following the Right Conversations <find-follow-conversations>` |
There was a problem hiding this comment.
Please add a maintenance table here
2 participants
This PR proposes following updates to learner facing discussion forum docs:
Future work: