Closed Bug 683690 Opened 10 years ago Closed 10 years ago

Create a system to track article updates that are needed

Categories

(support.mozilla.org :: Knowledge Base Software, task)

task
Not set
normal

Tracking

(Not tracked)

VERIFIED FIXED
2011-11-22

People

(Reporter: verdi, Assigned: rrosario)

Details

Attachments

(1 file)

One very common workflow for English KB editors to identify that an article either currently needs to be updated or that it will need an update for a future version of Firefox.

Currently we are making "empty" edits to articles and summarizing the required changes in the edit summary. This places the articles on the dashboard under unreviewd changes. The problem with that is this is meant to be a list of articles with actual revisions that need to be reviewed.

We need a separate facility that will allow us to:
* Mark an article as needing updates
* Summarize what updates are needed
* See a list of all documents that need to be updated along with their summary of needed changes

Bonus points for being able to target the updates to a specific fx version
Attached image Comment column
Michelle suggested we a column to https://support.mozilla.com/en-US/contributors/unreviewed that shows the note from the last revision. I think this could be the easy solution to this problem or at least a quick hack to help us until we can design something better.
Visual Part:

Add two items to the "description" field of all articles:
* Checkbox called "needs change"
* Text field below the checkbox
** Text field is grayed out until checkbox is checked.

Add a view to the KB dashboard:
* 3 columns: 
** Article Name (below that: change requested by xyz)
** Visits (as number and bar)
** Change Text (show only one line of text initially, clicking on the row resizes the text area to reveal full text of requested change)

Add item to "approve" modal window:
* Add checkbox for "needs change" (state is the same as on description field)

Mechanics:
* Add permission for request_change
* Checking the "needs change" checkbox puts the article on the KB dashboard
* Un-checking the checkbox during "approve" removes the item from the KB dashboard.
just to be clear:
un-checking the "needs change" checkbox in the article description field at any time removes the article from the KB dashboard
Assignee: nobody → rrosario
Target Milestone: --- → 2011-11-15
https://github.com/jsocol/kitsune/commit/b2619b6735a2c4bf1d457fbf10de1fec7c43ea98
Status: NEW → RESOLVED
Closed: 10 years ago
Resolution: --- → FIXED
Target Milestone: 2011-11-15 → 2011-11-22
Hey Ricky, this is great, but could you please change this so that instead of a mouseover a mouse click show the full change description permanently?
I see the 'needs change' checkbox and comment area, however I do not see the changes on https://support.allizom.org/en-US/contributors/unreviewed= nothing in the approve modal window, the KB dashboard, etc.
Status: RESOLVED → REOPENED
Resolution: FIXED → ---
(In reply to Rebecca Billings from comment #7)
> I see the 'needs change' checkbox and comment area, however I do not see the
> changes on https://support.allizom.org/en-US/contributors/unreviewed=
> nothing in the approve modal window, the KB dashboard, etc.

It shows up in https://support.allizom.org/en-US/contributors under the Needs Change header. Also here: https://support.allizom.org/en-US/contributors/need-changes

Then when approving a document you can change the setting if you have the admin permission to edit documents.
Verified all changes
Status: REOPENED → RESOLVED
Closed: 10 years ago10 years ago
Resolution: --- → FIXED
Status: RESOLVED → VERIFIED
I think this looks great. Thanks Ricky! 

Michael, Luna, what do you guys think?
Sorry, I meant Michelle. Michael and Michelle got me confused.
This looks great - making a video about it now.
Could someone check out what happens when you have an article on the https://support.mozilla.com/en-US/contributors/need-changes "Need Changes" list and then defer a pending revision?  I just added the "Installing Firefox on Mac" article to the Need Changes list (by editing the Description) and verified that it was on the list.  I then deferred the "empty edit" that was being used to control the needed change and the article disappeared from the Need Changes list! (I just added it back).

What makes me think that deferring a pending revision removes an article from the Need Changes list is that, on Nov 23, I got a "Your revision has been reviewed" e-mail notice from Michael Verdi that he deferred my "empty edit" to the "Latest Firefox issues" article with the comment, "I just moved the needs update comment to the new needs update feature!".  However, when I went to the list, it wasn't there.  I figured he just thought he added it but forgot, so I added it myself.
(In reply to Alice Wyman from comment #13)
> Could someone check out what happens when you have an article on the
> https://support.mozilla.com/en-US/contributors/need-changes "Need Changes"
> list and then defer a pending revision?  I just added the "Installing
> Firefox on Mac" article to the Need Changes list (by editing the
> Description) and verified that it was on the list.  I then deferred the
> "empty edit" that was being used to control the needed change and the
> article disappeared from the Need Changes list! (I just added it back).
> 
> What makes me think that deferring a pending revision removes an article
> from the Need Changes list is that, on Nov 23, I got a "Your revision has
> been reviewed" e-mail notice from Michael Verdi that he deferred my "empty
> edit" to the "Latest Firefox issues" article with the comment, "I just moved
> the needs update comment to the new needs update feature!".  However, when I
> went to the list, it wasn't there.  I figured he just thought he added it
> but forgot, so I added it myself.

Filed Bug 705652
Verified that Need Changes setting remains after deferring a revision- also still displays on /contributors page.
oops- this comment is for the new bug
You need to log in before you can comment on or make changes to this bug.