Support/Kitsune/KB/context scenarios/Bela
From MozillaWiki
< Support | Kitsune | KB | context scenarios
Contents
- 1 Bela: reviewing an edit on the page
- 2 Bela: reviewing an edit by mail
- 3 Bela: rejecting spam/vandalism
- 4 Bela: Review an article
- 5 Bela: Subscribe to an article without editing it
- 6 Bela: Subscribe to a category
- 7 Bela: view poll data for one article
- 8 Bela: edit more than one article
- 9 Bela: Edit a sub-page
- 10 Bela: Create a new article
- 11 Bela: Create a new article from the forum
- 12 Bela: Rename an article via the article
- 13 Bela: Rename an article via the articles forum
- 14 Bela: Remove an out of date warning via dashboard
- 15 Bela: Remove an out of date warning via dashboard
- 16 Bela: tweak search results
- 17 Bela: translate a sub-page
Bela: reviewing an edit on the page
- Bela has received a few messages about needed reviews and decides that it is time to bring that number down. She opens the dashboard and looks at the "review needed" section. It lists the articles together with some statistics about date of the review request, popularity of the article etc.
- She choses "How to set the homepage", a highly popular article for which Fred had requested review a week ago. She clicks on "review" and gets a nice and detailed visual diff about what changed since the last approval of the article.
- For every change she can accept or reject the changes. She is happy with everything except one change, so she rejects that change and writes a note in the comment field about why that edit was rejected.
- The edit is significant, so she checks an option that will mark translations of the article as "Needs updating" in the localization dashboard.
- She submits the review so that the article becomes visible to all users. Fred receives an email that Bela reviewed his article with the lines that were rejected and the note that Bela made.
Bela: reviewing an edit by mail
- Bela is working on her computer and gets an email informing her that Fred edited an article that needs review.
- Bela isn't in the mood to review right now, but she want's to peek at what changes Fred made. Luckily the email already contains information about that and a link to a more friendly view. Fred had only changed a few lines, so Bela decides to accpet that by clicking the "accept changes" link in the mail.
Bela: rejecting spam/vandalism
- Bela opens the localization dashboard to see if there are article edits waiting for review. There is an article with an edit waiting for review, so she clicks on "review" and gets a nice and detailed visual diff about what changed since the last approval of the article.
- As it turns out, the edit is simply vandalism. The spammer has not changed any article text, but added a pornographic image to the article.
- She rejects that change, but instead of writing a note in the comment field, she marks the edit as spam. As a result, not only is the change rejected, but no notification is sent to the spammer, any images and videos added in that edit are deleted, and the account that edited the article is deleted.
Bela: Review an article
- Bela gets an email notifying her that an article thread has been marked as ready for review.
- She clicks on a link to the article in the email, and reviews the article contents. Article discussion is also available to her, so she can see the reasoning behind the article.
- She decides that the article text is great, but the article needs some screenshots; so she creates a screenshot on her computer, and clicks on "edit this article".
- The article editor opens, and she places the cursor where she wants to add a screenshot, then clicks "Add screenshot" to upload here image.
- She is then asked to choose which Firefox version and operating system the image is of. She chooses Firefox 4.0 and Windows, then clicks "Insert". The image gets automatically inserted where the cursor was on in the article, and made available to her in an image library for the article.
- She doesn't want to be notified of any future changes to the article, so before saving her edit, she unchecks a box that will subscribe her to email notifications for any future edits to that article or posts in the corresponding article discussion thread.
- She saves her edit, which then takes her back to the article draft. She chooses to approve the article, and clicks on "Approve".
- The article is then made public, a staging copy is automatically created, and the article thread is automatically resolved.
Bela: Subscribe to an article without editing it
- Bela wants to keep up with changes to an article she has not edited, so she goes to the article and clicks on subscribe.
- She is then notified that she is subscribed to all edits and thread posts to the article, and given a link/button to unsubscribe.
Bela: Subscribe to a category
- Instead of monitoring each individual article, Bela decides she wants to monitor the entire KB.
- She visits the category landing page, and just like regular KB articles, there is a link to monitor the article.
- She clicks on the link, and a notice at the top of the page confirms that she has subscribed.
- She will get a notification whenever someone edits or comments on an article in that category.
Bela: view poll data for one article
- Bela previously edited an article, and now she wants to see if her edit has made the article better. She goes to sumo and logs in.
- After logging in she is taken to her dashboard, which lists edits she has previously made, and links her to a view of the article history.
- She clicks on the link to the article she previously edited, and it takes her to the articles history page with a graph displaying how the helpfulness score of the article has changed since over time, with markings for when each edit was made. It highlights her edit, and the difference in the score since her edit.
Bela: edit more than one article
- The text on a Firefox setting has changed in a new version of Firefox. Bela wants to update the KB for this change. She goes to the approvers dashboard, and launches Find and Replace for the KB.
- She enters the text that needs to be replaced in the KB, and the Find and Replace feature displays all affected articles, with a snippet of the content in the article where text appears.
- After looking at the affected pages, she sees that the text on one of the pages is referring to something completely different, so she does another search, but this time includes the markup that is usually around the text she is looking to replace.
- This time only articles that will need to be updated are displayed, so she goes ahead and enters the replacement text. As before, a list of affected articles appears, but this time she can preview each article with a change.
- She decides to go ahead and apply the change, so she selects each article she wants to apply the change to, and confirms the action.
- The changes are applied to the staging copy of each article, and await the same review process as regular article edits.
Bela: Edit a sub-page
- Bella sees wants to add a screenshot to the sub-page, so she visits an article that contains one of the sub-pages.
- She opens that page in the article editor. Near the pointer (include) to the sub-page, is a link to edit the sub-page. She clicks on that link, and a new editor window opens, where she can edit the sub-page.
- She adds a screenshot to the sub-page, and saves her edit.
- The edit is saved in a staging copy of the sub-page, where it awaits review.
Bela: Create a new article
- From her KB Editors group dashboard, Bela clicks on the "create a new article" item.
- She is taken to a new article in Edit View.
- She adds the main article title (doing this also creates a discussion forum for the article)
- The article already contains one resizable section with a rich text editor.
- Bella drags the bottom right corner to create some room for her to work.
- She then starts by writing the introduction.
- Since this article will apply to many different OSes and Firefox versions, she sets these in the Showfor section of the sidebar.
- As she continues to work on the introduction, she gets to a section that will contain information for different OSes. She writes them out in one sentence. Then she highlights some text that applies only to Windows and Fx4, clicks the Showfor button and chooses what tags this highlighted section of text will apply to. The result is that section of text now has a corresponding background color in the editor. Example
- Next Bela wants to add some Step-by-Step instructions she clicks the "Add a new section" button below the previous section that she was working on. This gives her a new blank section to work in. Again she drags the bottom right corner to create some more room for her to work in.
- She adds a section heading and a brief description. Then before the first step, Bela clicks the "New Step" button and a visual indication is added to the document. Example
- For this first step Bela drags a screencast she's made into the article window. (Example) The video gallery window pops up and asks her to name the video and select the showfor tags. Then she clicks save and a proxy is added to the document while the video is compressed into multiple formats and uploaded in the background.
- Next Bela adds the text for that step below the video.
- Then Bela starts a new step by clicking the New Step button.
- This time Bela wants to add a screencast that's already in the video gallery so she clicks the insert video button. The video gallery pops up and she chooses the video she wants by clicking on it. It's then inserted in the article complete with it's showfor information. Example
- Realizing that she's been working on this for a while now, Bela clicks "Save and Continue" before moving on.
- Once she's done with that Step-by-Step section, Bela creates another one by again clicking the "New Section" button below the current section.
- This next step-by-step section will contain images instead of videos.
- Bela continues adding steps with images via drag and drop and the image gallery. Example, Example
- One of Bela's screenshots could use some additional explanation so she decides to add a note to it. To do that Bela just clicks and drags on the image to create a red box that she can position anywhere on the image. There is also a place for her to enter the on hover text. Example
- Now that she's just about done, Bela switches to the Article View/Preview view to see how things will look and work for the user.
- Switching back to Edit View, Bela decides to reorder the sections of the article. She can easily do this by grabbing each section's handle and dragging it into the order she wishes. Example (works like a Netflix queue)
- Now that she's done writing the article, Bela makes sure all of the article's meta information is set - category, type of article, table of contents on or off, keywords, etc.
- She also adds a summary of the edits she's made.
- Finally, she clicks submit.
Bela: Create a new article from the forum
- A discussion in the contributors forum reveals the need for a new KB article.
- Bela starts a new thread in the articles forum which automatically creates a new article with the name of the thread.
- Following the link in the thread she just created, Bela is taken to the article editor.
- In the article editor Bela notices that the article title field has been automatically filled in.
- She then continues editing the article.
Bela: Rename an article via the article
- Bela doesn't like the name of an article, and after some discussion in the article thread, it is decided that she will rename the article.
- She goes to the article, and clicks on "edit this article". The article editor opens, containing a text field with the article name.
- She replaces the text in the article name field, and adds the old name to an optional "alternate names" field, then saves her edit.
- The article, its staging copy, and the article thread are renamed, maintaining translations. The old URL now redirects to the new URL.
Bela: Rename an article via the articles forum
- Bela doesn't like the name of an article, and after some discussion in the article thread, it is decided that she will rename the article.
- On the original post in the thread, she clicks on a link to edit the thread title.
- She replaces the text in the article name field, and adds the old name to an optional "alternate names" field, then saves her edit.
- The article, its staging copy, and the article thread are renamed, maintaining translations. The old URL now redirects to the new URL.
Bela: Remove an out of date warning via dashboard
- Bela looks at the Localization Dashboard, and sees that one article is marked as "needs updating", so she clicks on the link to the article from the dashboard, which opens the article in the editor.
- The editor also contains a diff view of changes made to the English article as well as a summary of each change. She makes the appropriate changes to the article and saves the edit.
- The article remains under the "needs updating" section of the dashboard, but the status is set to "needs review".
- When the edit is approved, the warning is removed from the article, and the article goes back to being marked as "Translated" in the dashboard.
Bela: Remove an out of date warning via dashboard
- Bela visits an article and sees that it has a "Content may be out of date" warning, so she clicks on the "edit this article",which opens the article in the editor.
- The editor also contains a diff view of changes made to the English article as well as a summary of each change. She makes the appropriate changes to the article and saves the edit.
- The article remains under the "needs updating" section of the dashboard, but the status is set to "needs review".
- When the edit is approved, the warning is removed from the article, and the article goes back to being marked as "Translated" in the dashboard.
Bela: tweak search results
- Bela sees that a trended search phrase is "clear cash". Knowing that those users probably want the "How to clear the cache" article, she goes to the article, and clicks edit.
- Within the editor is a section to add search keywords. There, she adds the term "cash", then saves her edit.
- After the edit is saved, she approves her edit, and that change is documented in the article history.
Bela: translate a sub-page
- Bela is translating an article and comes across a sub-page. SUMO recognizes that he sub-page is not translated into Bela's language, so there is a link provided beside the sub-page for her to create a translation of it.
- She clicks on the link, and a new tab opens, and follows the same steps as she would to translate any other article.