446071 - Add links to best practices, style guide, and policies at the top of the editor

Status: VERIFIED FIXED

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

Description

[Chris Ilias [:cilias]]

When editing an article, there's a notice at the top, saying "You are editing the staging copy of the approved version of this page. Changes will be merged in after approval."

We can make people more aware of the system and documentation by enlarging that notice, by adding links to:
http://support.mozilla.com/en-US/kb/Best+Practices+for+Support+Documents
http://support.mozilla.com/en-US/kb/Style+Guide
and the policies page (bug 446066)

Comment 1

[Paul Craciunoiu [:paulc]]

Should these links be shown only when editing the staging copy, or also when editing an approved version?

Comment 2

[Paul Craciunoiu [:paulc]]

{tr}For more information, please read <a href="http://support.mozilla.com/en-US/kb/Best+Practices+for+Support+Documents">best practices</a>, <a href="http://support.mozilla.com/en-US/kb/Style+Guide">style guide</a>, or <a href="http://support.mozilla.com/en-US/kb/Knowledge+Base+policies">policies</a>.{/tr}

Here's a sample text that would be added inside the same notice. Sound good?

Comment 3

[Chris Ilias [:cilias]]

Theoretically, the only reason someone would be have a KB copy in the editor (rather than the staging copy) would be to move the article out of the KB category, or to implement something like a redirect. So it won't hurt if this doesn't apply when editing the KB copy.

I'll suggest wording after I've got some sleep. :-) But this isn't really a "For more information..." thing, but more of a "Make sure you read..." thing. The policies page is the important one.

Comment 4

[Paul Craciunoiu [:paulc]]

Got it :-)... waiting for review.

Comment 5

[Chris Ilias [:cilias]]

Here's something to replace the entire box. I'm unsure that box is localizable, but the contributor docs are, so I took out the locales from the URLs. CCing David. David could you review this text:

"You are editing the <strong>staging copy</strong> of the article. Changes will be applied after review, to make sure your changes are accurate and follow <a href="http://support.mozilla.com/kb/Knowledge+Base+policies">Knowledge Base policies</a>. For guidelines, please read our <a href="http://support.mozilla.com/kb/Best+Practices+for+Support+Documents">Best Practices for Support Documents page</a>, and <a href="http://support.mozilla.com/kb/Style+Guide">Manual of Style</a>."

Comment 6

[Paul Craciunoiu [:paulc]]

David, could you review Chris's text? :)

Comment 7

[Chris Ilias [:cilias]]

I don't think David will be back from vacation in time to review this. CCing Cheng and Matthew.

Comment 8

[Chris Ilias [:cilias]]

What am I saying? This is a 0.9 bug, not a 0.8.1 bug! :-)

Comment 9

[[:Cww]]

A few nitpicks:
Changes will be applied after [a] review [no comma] to make sure [they] are accurate and follow [the] <a
href="http://support.mozilla.com/kb/Knowledge+Base+policies">Knowledge Base
policies</a>.

Also no comma before the last "and".

Comment 10

[Paul Craciunoiu [:paulc]]

Sounds good. Shall I go ahead and "fix" the bug? :)

Comment 11

[Chris Ilias [:cilias]]

Yup. Thanks Cheng!

Comment 12

[[:Cww]]

Yeah, sorry, that's definitely a go.

Comment 13

[Paul Craciunoiu [:paulc]]

r21676 / r21677
There we go.

Comment 14

[Stephen Donner [:stephend] Not actively reading bugmail]

Attachment: Post-fix screenshot (staging)

Comment 15

[Stephen Donner [:stephend] Not actively reading bugmail]

Verified FIXED on https://support-stage.mozilla.org/tiki-editpage.php?locale=en-US&page=*Cannot+connect+after+upgrading+Firefox.

Comment 16

[Underpass]

As I already said to Paul, I found two additional issues in translating the strings:

1) The strings are two and are too long. English words are usually shorter than Italian words, and so I had to leave something outside in order to fit the maximum length permitted. This problem could be easily experienced for other languages.

So I think each string should be in turn split in other two strings, or the maximum string length should be increased (the first option is better, IMO).

2) The Italian translated strings do not show up. They are in the translation table (search the word "policies" for it and you can check it), but I still see them in English.

Ok, if one is able to translate a page he should as well be able to read the two strings in English, but I think this is still a problem :-) 

Bye

Comment 17

[Chris Ilias [:cilias]]

If there are any issues, it's best to file separate bugs for each of them. That way, each issue can be tracked, with assignees, patches, and QA. It's a lot harder to make sure each bug gets fixed, if we can't track each one separately.