Closed
Bug 886699
Opened 11 years ago
Closed 5 years ago
[kitsune] documentation sections marked as {for TBxx} with xx = future version are shown, but should be hidden
Categories
(support.mozillamessaging.com Graveyard :: General, defect)
support.mozillamessaging.com Graveyard
General
Tracking
(Not tracked)
RESOLVED
WONTFIX
People
(Reporter: thomas8, Unassigned)
References
Details
(Keywords: ux-efficiency, ux-error-prevention)
+++ This bug was initially created as a clone of Bug #720243 +++ STR 1) Write KB article with some information that applies to a *future version* of the product, e.g. Thunderbird Keyboard Shortcuts documentation (1). For example, write markup to document changes of TB keyboard shortcut for composition's Find & Replace command: TB 5 to TB23: Ctrl+F from TB24 onwards: Ctrl+F, or Ctrl+H 2) Use {for} syntax (2) to effect showing the new shortcut only for TB24 upwards {for tb5}Ctrl+F {for tb24}, or Ctrl+H{/for}{/for} Actual Result - Valid syntax {for tb24} fails to hide sections explicitly marked for future version (current version =tb17) - Sections marked for future versions always show for present versions - Cannot update documentation in advance; clumsy workflow: have to file a bug or make notes now to ensure that we remember to change the document later when the new version is out - easy to forget, forces error-prone last-minute edits Expected Result Given that current version stands at =tb17, any section marked with a higher version (e.g. {for tb24}, or Ctrl+H{/for}) should be hidden (not shown) Reasons: With rapid release cycle and up to almost 9 release versions per year (FF), we will most likely have more cases where some information only applies to future versions. Efficient workflow requires writing up documentation for future versions *in advance* and as early as possible, ideally at the time when the changed behaviour has landed in code (e.g. on Aurora, and we're sure it won't change later). (1) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts (2) https://support.mozilla.org/en-US/kb/how-to-use-for
Reporter | ||
Comment 1•11 years ago
|
||
Can somebody push this into the right Product/Component for Kitsune or whatever it's called?
Keywords: ux-efficiency,
ux-error-prevention
Reporter | ||
Comment 2•11 years ago
|
||
(In reply to Thomas D. from comment #1) > Can somebody push this into the right Product/Component for Kitsune or > whatever it's called?
Flags: needinfo?
Status: NEW → RESOLVED
Closed: 5 years ago
Flags: needinfo?
Resolution: --- → WONTFIX
You need to log in
before you can comment on or make changes to this bug.
Description
•