GNOME Bugzilla – Bug 561033
Work on the documentation
Last modified: 2009-04-14 07:29:56 UTC
Documentation Section: This bug is for keeping track of the work on the documentation. The repo with the documentation is on GitHun, for more information see http://live.gnome.org/Empathy/Documentation Correct version: Other information:
Created attachment 122780 [details] Documentation so far This is the last edited version of the manual as of November 2008.
Created attachment 126233 [details] [review] Documentation so far Small updated documentation.
Created attachment 126304 [details] New version of the documet New version with "planning" link.
> At the moment &app; does not support automatic registration > of any accounts. If you want to use a <emphasis > role="strong">Jabber</emphasis> account, you need to have > an already registered one or you can use the > <emphasis role="strong">Google Talk</emphasis> one. It has been possible for quite some time now to register new Jabber accounts, even though the feature is not perfect yet.
(In reply to comment #4) > It has been possible for quite some time now to register new Jabber accounts, > even though the feature is not perfect yet. I tested again and it's working, but not with all the Jabber server. I tested jabber.org and it works (last time I checked it wasn't), but not jabber.linux.it. Are you aware of other servers that work? I think it's better to say that in the document, that probably not all Jabber servers work.
It would probably be useful to open another bug (if it doesn't exist already) with a list of servers where registration doesn't work.
All servers does not support registration, gtalk is a good example. Building a list is impossible, anyone can setup a jabber server... The user is supposed to know a little bit about the server he is going to connect to.
(In reply to comment #7) > All servers does not support registration, gtalk is a good example. Hmm... yesterday I tested with jabber.org, and it worked: I created a new jabber account in Empathy (Ubuntu Jaunty version) using jabber.org as a server and it worked perfectly. Is it the only server that works? > Building a > list is impossible, anyone can setup a jabber server... Not an entire list, but at least we can maybe keep track of working servers in live.gnome.org/Empathy under a subpage, so we can: - or link that page from the documentation - or update the documentation based on that page > The user is supposed to > know a little bit about the server he is going to connect to. Yes and no, I tend to disagree here. IMHO, we are supposed to help as mush as we can the end user, so probably saying something likt "not all servers work for auto-registration, we are aware of these working servers..." and listing them or linking them could be of help. All, IMHO.
I tend to agree with Milo, perhaps we could contact a few free services and ask them if it is ok to list them in the documentation (I believe there would be no problem for apinc.org, for example); and live.gnome.org could have a more complete listing of known working/not-working servers. (actually such a list could even be used by Empathy itself to display informative messages to the user...)
jabber.org used to have a list of servers, but I can't find it now. Linking to an external list might be better than keeping one up to date in the docs.
(In reply to comment #10) > jabber.org used to have a list of servers, but I can't find it now. Probably is this one: http://www.jabber.org/web/Services > Linking to > an external list might be better than keeping one up to date in the docs. But I would tend to use GNOME resources if we can, even if in this case it means a little bit of duplication. At least it will feel more GNOMEish. If it's OK I'll create l.g.o/Empathy/Servers
Milo: if you create that page, you sign a paper telling you agree to maintain it for the next 10years :D I don't like the idea of maintaining a list ourself. That's the kind of page that gets outdated very fast and then become useless. We could propose some (like 2 or 3) very well known servers in the open source world in empathy's doc, though.
(In reply to comment #12) > Milo: if you create that page, you sign a paper telling you agree to maintain > it for the next 10years :D Hmmm... 10 years... quite a long time... :) Anyway, I wouldn't mind creating and maintaining it, checking it like before every Empathy/GNOME release, I think it could be pretty useful. > I don't like the idea of maintaining a list ourself. That's the kind of page > that gets outdated very fast and then become useless. We could propose some > (like 2 or 3) very well known servers in the open source world in empathy's > doc, though. Yes, indeed, a couple of known working Jabber servers could be inserted in the doc. The list, as of know, of working servers with automatic registration is: - jabber.org Well... instead of writing them here, I'll create that page! :) http://live.gnome.org/Empathy/Servers If we don't need it anymore we can always delete it. ;)
I worked a little bit on the documentation: - added the Jabber auto-registration thing - reworked the way you add an account to empathy - added a section on the Advanced Options Regarding the Advanced Options, I need some input on what some of those options really do or mean. Like for the Jabber account: - Resource - Priority what do those really mean and do? I think I can use the same account at the same time on two different locations... The "Ignore SSL certificate errors" what kind of "SSL certificate errors" does it ignore? Auto-signed one? Thanks for any help you can provide!
Created attachment 126797 [details] New version of the documet
I committed the new version. If you have a GNOME svn account, the best is to commit yourself updates. If you don't have one maybe you should request it ;) Thanks for your work!
(In reply to comment #16) > I committed the new version. Thank you. > If you have a GNOME svn account, the best is to commit yourself updates. If you > don't have one maybe you should request it ;) No, I asked for a translator account like 3 months ago, but nothing came out of it and I'm still waiting. > Thanks for your work! Thank you! I'll be up again writing the documentation next week or maybe even this weekend.
Maybe you need more approval from maintainers. I can confirm that you do great job for Empathy's doc if needed. I don't remember how I did to get my svn account in the first place...
(In reply to comment #18) > Maybe you need more approval from maintainers. I'm waiting a response from the Italian translators coordinator, but he looks missing when needed! :) > I can confirm that you do great > job for Empathy's doc if needed. If you feel like doing it, I would really appreciate it, and I'll be eternally grateful to you! > I don't remember how I did to get my svn > account in the first place... Looks like a really looooong process to me... :)
Created attachment 127724 [details] [review] Small update This is a small update: - added the Importing Accounts section on how to import accounts from Pidgin - modeve the Editing Personal Information in the Accounts section as it is related to account - a little rework on other sections
Committed your update, thanks for your work.
As I am translating the documentation, I found the following typo: "Select the account you wish to edit in the box on the left and double-click " "on it's name." ^^^^ <- its
Created attachment 130307 [details] [review] New patch for the Advanced Options section This patch adds an "Advanced Options" section. I've asked on the mailing lists if it's ok to commit. If I have the go I'll commit it.
Is that patch already applied? I can't apply it...
(In reply to comment #24) > Is that patch already applied? I can't apply it... > Yes, it was applyed just before the 2.26 release. I forgot to say it here. Thank you.
Ok. Can we close the bug then? If you have an SVN account you can commit your changes directly.
(In reply to comment #26) > Ok. Can we close the bug then? If you have an SVN account you can commit your > changes directly. > Yes, I can commit directly. It's possible to close the bug even if the manual is not really complete (it doesn't cover all empathy's feature).
I don't think we need to keep this bug open then. You can just commit your work in trunk.