Community
Participate
Working Groups
Currently the user guide is part of Mylyn help, but the FAQ is not. It makes sense to include the FAQ as well.
This could make sense as a linked online resource. I would like to be able to update the FAQ more frequently than new versions are released. We'd also have to review and update the FAQ. Some entries still refer to Mylar.
The idea is that the FAQ would continue to exist online, and also be included in the help bundle. Having it in the bundle would make it searchable within the Eclipse help system and would also make it available offline. It would also ensure that FAQ content accurately reflects the installed version of Mylyn. It would be trivial to add a link to the online version from the offline version, as we currently do with the user guide. (In reply to comment #1) > I would like to be able to > update the FAQ more frequently than new versions are released. Agreed, that makes sense. Having the FAQ on the wiki would make that possible. > review and update the FAQ. Some entries still refer to Mylar. Agreed, the FAQ should be up to date and accurate -- however that applies regardless of whether it's available within the bundle.
+1 for inclusion
> It would be trivial to add a link to the online version from the offline > version, as we currently do with the user guide. That's a good idea. > Agreed, the FAQ should be up to date and accurate -- however that applies > regardless of whether it's available within the bundle. True, but before we make the content more prominent and searchable on help.eclipse.org outdated entries should at least be removed. I think it's more harmful than helpful if entries describe workarounds for fixed bugs or reference non existing UI elements etc.
David, do you want to take this on for 3.4? I'll make sure that we go through the entries and update the content before the release.
(In reply to comment #5) > David, do you want to take this on for 3.4? I'll make sure that we go through > the entries and update the content before the release. Sure!
I've implemented this change in CVS. Mik, Steffen, if you could review my changes I'd appreciated it.
Is there a good way to include a link to the most up-to-date online version? We'll end up with a copy of the FAQ on help.eclipse.org which will only be updated three times year and probably have a higher search rank than the Wiki version.
(In reply to comment #8) > Is there a good way to include a link to the most up-to-date online version? Yes, currently we have the following appended at the end of the FAQ. It would be relatively trivial to add something to the start of the FAQ page as well: h2. Updating This Document This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit http://wiki.eclipse.org/Mylyn/FAQ
Nothing left to do here.
