After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 575424 - Documentation for gnome-bluetooth
Documentation for gnome-bluetooth
Status: RESOLVED OBSOLETE
Product: gnome-bluetooth
Classification: Core
Component: general
2.27.x
Other Linux
: Normal normal
: ---
Assigned To: gnome-bluetooth-general-maint@gnome.bugs
gnome-bluetooth-general-maint@gnome.bugs
Depends on:
Blocks:
 
 
Reported: 2009-03-15 13:56 UTC by Baptiste Mille-Mathias
Modified: 2011-08-31 20:26 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
a tarball with help files (62.42 KB, application/x-gzip)
2009-03-15 20:34 UTC, Baptiste Mille-Mathias
  Details
diff for text files (22.17 KB, patch)
2009-03-17 21:14 UTC, Baptiste Mille-Mathias
none Details | Review
the figures for the documentation (54.92 KB, application/x-gzip)
2009-03-17 21:15 UTC, Baptiste Mille-Mathias
  Details
previous diff was not done at root directory :/ (23.66 KB, patch)
2009-03-17 21:17 UTC, Baptiste Mille-Mathias
needs-work Details | Review
patch for documentation (21.93 KB, patch)
2009-03-29 19:29 UTC, Baptiste Mille-Mathias
none Details | Review
here follow the figures (67.62 KB, application/zip)
2009-03-29 19:32 UTC, Baptiste Mille-Mathias
  Details

Description Baptiste Mille-Mathias 2009-03-15 13:56:51 UTC
I'm in the process of writing the documentation.
I think I did about 70%.
I'll try to achieve a good part soon, and post it here.
Comment 1 Baptiste Mille-Mathias 2009-03-15 20:34:51 UTC
Created attachment 130710 [details]
a tarball with help files
Comment 2 Baptiste Mille-Mathias 2009-03-15 20:41:56 UTC
The doc is still rough, and as we're still at early stage of 2.27.x, so I'm not sure if it necessary to commit that right now.

I accept corrections & suggestions with great pleasure.
Comment 3 Baptiste Mille-Mathias 2009-03-17 21:14:54 UTC
Created attachment 130855 [details] [review]
diff for text files

I think I reach some kind of milestone, I covered each option.
I not documentation expert, and my wording is far from perfect, so perhaps someone from documentation team should review it (it is perhaps too early in the cycle, as the UI and options will change) ?
Comment 4 Baptiste Mille-Mathias 2009-03-17 21:15:16 UTC
Created attachment 130856 [details]
the figures for the documentation
Comment 5 Baptiste Mille-Mathias 2009-03-17 21:17:51 UTC
Created attachment 130857 [details] [review]
previous diff was not done at root directory :/
Comment 6 Bastien Nocera 2009-03-26 10:45:30 UTC
Could you please update the docs for the current UI? (and review the UI for stupidness as well). I'll try to keep it up-to-date after committing it.
Comment 7 Baptiste Mille-Mathias 2009-03-26 11:05:15 UTC
Okay I can do it; do you have a ultimatum for that, because I can't do that tonight, but I think I can do that for next Monday.

I can help you to keep the documentation updated as well, <bluesky mode="on"> although a good policy would be to have documentation updated with any commit that change something in the doc.</bluesky> :)

Also, did you check the Makefiles ? because I tried to follow guidelines in wiki and took ripped code from other module, it seems to work for me, but I'm certainly not expert for that :).
Comment 8 Baptiste Mille-Mathias 2009-03-29 19:29:28 UTC
Created attachment 131641 [details] [review]
patch for documentation

Some fixes.
It seems the UI has farly changed since last time.
few things I noticed:
- the checkbox "powered" disappeared from properties, is it a bug? anyway I let the option in the documentation, if this is not a bug (which seems to me weird), you can drop this part.
- the general tab was dropped from properties, but I think this is wanted, so this is reflected in doc.
- the properties padding seems to me a bit high
Comment 9 Baptiste Mille-Mathias 2009-03-29 19:32:41 UTC
Created attachment 131642 [details]
here follow the figures
Comment 10 Bastien Nocera 2009-04-06 16:33:04 UTC
(In reply to comment #8)
> Created an attachment (id=131641) [edit]
> patch for documentation
> 
> Some fixes.
> It seems the UI has farly changed since last time.
> few things I noticed:
> - the checkbox "powered" disappeared from properties, is it a bug? anyway I let
> the option in the documentation, if this is not a bug (which seems to me
> weird), you can drop this part.

Powered is only visible if there's no killswitch. We shouldn't even have it in the UI I think...

> - the general tab was dropped from properties, but I think this is wanted, so
> this is reflected in doc.

I re-added the preference to the properties (although, as usual, padding is off).

> - the properties padding seems to me a bit high

The properties needs someone who has a clue to redo the padding and fix up this mess.
Comment 11 Bastien Nocera 2009-04-10 01:50:33 UTC
Committed the first pass:
http://svn.gnome.org/viewvc/gnome-bluetooth?view=revision&revision=601

I added the missing OMF file, so it's shown in the yelp front page. I still need to hook the help buttons.

Also note that it's "Bluetooth" with a capital B, not "bluetooth". And we should explain either explain pairing, or completely side-step the problem, and say that the user has "set up" such and such device.

I'll try and update all that when I get a chance.
Comment 12 Baptiste Mille-Mathias 2011-08-31 20:26:58 UTC
I guess this bug can be close as OSBOLETE right ?