If you think a bug might affect users in the 57 release, please set the correct tracking and status flags for Release Management.

help-files for Lightning



11 years ago
4 years ago


(Reporter: Bas van den Bosch, Unassigned)






11 years ago
We need a unified system for help-files. Currently there are four (or more?) places where help-files are spreaded:

The extend of the information and the xul at mozdev is really nice but the info outdated and is no longer supported. The wiki has a lot of information but the info from the FAQ (the mentioned entry-point) is rather outdated while http://wiki.mozilla.org/Calendar:Home_Page is up-to-date. The FAQ and other info at mozillazine really small. I think all help-files should live on the wiki while www.mozilla.org should be a rather short page which links to the wiki. Ideally also kb.mozillazine.org should be the same short page while molzdev contains the updated help-files in the xul-application. I'll setup an scheme and will add it to this bug.

Comment 1

11 years ago
We need the following pages on the wiki
wiki/Calendar   - already exists

* short text about current version
* Help-pages - should link to wiki/Sunbird:<version>:Help
* Release Notes for Sunbird - should link to wiki/Sunbird:<version>:Relnotes
* Previous Versions - Little History and links to help-files for prev versions
* Calendar Project - link to wiki/Calendar:Home_Page

* version-number
* using help
* about - back to wiki/sunbird
* performing basic tasks
* working with events
* known problems - commonly encountered on the forum
* customizing
* sharing calendars
* invites
* getting more help 
etc etc

By including the version-number in the wiki-page we're able to have help-pages for pre-versions and during the process of developing a new version already work on the help-files. 

The Calendar:Home_Page already exists, the only thing to do here is add some text about the obsolete calendar-extension and about the temporary sunbird-versions which we call Calendar. The pages under Calendar will also hold all help-pages which are shared between lightning and sunbird like the provider-stuff: 
and for instance the difference between publishing and subscribing

At some point when we think the help-pages are complete enough we can copy-paste them into the calendarhelp-extension (versioning should comply with SB/lightning versioning!), preferably at the same time with a new release. Localized version of the help-pages can be written in wiki too like:
and can be released only after a peer has checked them for consistancy with the main help-files in english.

In this setup the most complicated part will be the differentiating between the sunbird-pages, lightning-pages and common pages. When the setup is completed for the first time, next versions will be easier.  

Installing the calendarhelp-plugin requires some hacking of xul-files, we have to see if it's possible to install without manually editing files before releasing this as an addon by the calendar-project. 
If by 'the wiki' you mean 'wiki.mozilla.org', I disagree with you. That wiki is not really for end-user documentation. It's a gathering of mostly developer oriented documents, and should stay that way.
So let's find a different wiki :)

Comment 3

11 years ago
I see writing the help-pages as a development-process too :) With every fix some text may have to be rewritten. We could use doctor.mozilla.org but in that you have to write html which is much more cumbersome. With every official release we could transfer the pages to http://www.mozilla.org/projects/calendar/ and I agree this would be better. But let's not find a different place for writing these pages as then you get things like the calendarhelp-project which has really outdated data and it makes things very unclear. We already have difficulties keeping  wiki.mozilla.org/Calendar up-to-date (the faq still applies to the calendar-addon for an example). To clarify: wiki.mozilla.org or www.mozilla.org/projects/calendar is the goal for the help-pages, the calendarhelp-addon is a nice-to-have for now...
You should not add new top-level namespaces to wiki.mozilla.org. So wiki/Lightning is pretty-much a no-go. Also, mixing documentation and developer stuff on the same level will be confusing and messy.
Thus I suggest to add some level: wiki/Calendar/help/Lighning/Foo (or : instead of /, i don't know which is to be used)
Those pages can be used as scratchpad. When done, they can be put somewhere more permanent.

Comment 5

11 years ago
Ok for me, think its a good place for creating helpfiles...

Comment 6

10 years ago
Shouldn't "Target Milestone" be changed to 0.7?
Target Milestone: Sunbird 0.5 → 0.7

Comment 7

10 years ago
I greatly appreciate any talented writers producing help content and technically would favor the wiki, too; just because of its ease of use.
Due to the fact that to UI is still going to change, we should target this bug for 1.0, although the latter shouldn't discourage anybody from starting now ;)
Target Milestone: 0.7 → 1.0


10 years ago
Blocks: 353668

Comment 8

10 years ago
just for reference: Simon has called for volunteers on the weblog as well as on the mailing list.



10 years ago
Flags: wanted-calendar0.9+


10 years ago
Flags: wanted-calendar0.9+ → wanted-calendar0.9-


7 years ago
Blocks: 615122


7 years ago
No longer blocks: 615122
We have some support.mozillamessaging.com wiki pages now.
Last Resolved: 7 years ago
Resolution: --- → FIXED

Comment 10

7 years ago
I guess you mean:

The help-files are far from complete though so I think this bug should stay open.
Alright, let's keep it open.

Of course, we could always use some help keeping them up-to-date / updating them.

So, if anyone from the people CCed to this bug would like to help, go for it.
Resolution: FIXED → ---
Target Milestone: 1.0 → ---
Flags: wanted-calendar0.9-
Summary: help-files for Sunbird and Lightning → help-files for Lightning

Comment 12

4 years ago
Seems to talk a lot about the same stuff as bug 741997. See 741997 comment 4. That + the kb transit to support.mozilla.org would appear to make this bug largely void. Help file are always good but the bug won't help create them. People would just create the support articles directly on sumo.
As we have https://support.mozilla.org/en-US/products/thunderbird/calendar now, which should be extended if necessary, I close this bug as WONTFIX.
Last Resolved: 7 years ago4 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.