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 556500 - [gadg] port to gnome-doc-utils
[gadg] port to gnome-doc-utils
Status: RESOLVED FIXED
Product: gnome-devel-docs
Classification: Applications
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gnome-devel-docs maintainers
gnome-devel-docs maintainers
Depends on:
Blocks:
 
 
Reported: 2008-10-16 07:44 UTC by Frederic Peters
Modified: 2008-11-20 15:52 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Frederic Peters 2008-10-16 07:44:35 UTC
It would be nice for the GNOME Accessibility Developers Guide to be ported to gnome-doc-utils, so it can be made available on library.gnome.org, and translated.

Vincent: this requires moving files around, if you have any pending patches, could you commit them so you do not suffer merge-pain after the move?
Comment 1 Vincent Alexander 2008-10-16 14:48:15 UTC
All patches to the old location have been committed to date / were committed before the relocation. Could someone note the full new svn co path?
Comment 2 Frederic Peters 2008-10-16 15:05:16 UTC
It will be svn+ssh://username@svn.gnome.org/svn/gnome-devel-docs/trunk/gadg/C/ ;
I'll make the move now.
Comment 3 Frederic Peters 2008-10-16 15:15:07 UTC
Well; I didn't ask if it was okay, Shaun: is this ok?  I'll not enable it in the main Makefile.am SUBDIRS=, or in configure.ac; but it will be picked up by library.gnome.org nevertheless.
Comment 4 Shaun McCance 2008-10-16 15:25:47 UTC
You'll have to put it in configure.in for g-d-u stuff to work.  Or are you just planning on having a "dummy" Makefile.am that never produces a Makefile?  If it's in configure.in, but not included in the tarballs becuase it's not in SUBDIRS, bad things will happen.

I want to discuss naming before we enable this.  I don't care for complete initialisms for document identifiers.  Does anybody object to accessibility-devel-guide?  This would involve changing the name of the directory, changing the name of the XML file, and using that name in the .omf.in file we add.
Comment 5 Frederic Peters 2008-10-16 15:31:49 UTC
Yes; library.gnome.org works with "dummy" Makefile.am.  And I support the rename idea as accessibility-devel-guide is much more readable (and similar to other documents).
Comment 6 Vincent Alexander 2008-10-25 19:16:46 UTC
The name change sounds great to me -- if you can make this happen, I'd really appreciate it.
Comment 7 Shaun McCance 2008-10-26 20:25:49 UTC
Done.  Vincent, you'll find your work in accessibility-devel-guide now.
Comment 8 Vincent Alexander 2008-10-26 22:18:51 UTC
Thanks, Shaun.
Comment 9 Willie Walker 2008-10-27 15:30:07 UTC
Thanks all!  So, for follow up work to do:

1) We need to make sure the images are uploaded.  I'm not sure if this is a Makefile thing or not (Vince, Shaun?), but I notice the current stuff is missing at least this image: http://library.gnome.org/devel/accessibility-devel-guide/nightly/images/GNOME_desktop_Accessibility.png.en

2) The "Accessibility for Developers [external resource]" link on http://library.gnome.org/devel/guides points to an outdated version of Vince's "GNOME Accessibility Developers Guide" link on the same page.  As such, I think we can just ditch the "Accessibility for Developers [external resource]" section on http://library.gnome.org/devel/guides.

Thanks so much!  I think we're finally going to get GNOME accessibility docs to the point where they are up-to-date and we'll also have a decent maintenance/publication plan in place.
Comment 10 Frederic Peters 2008-10-27 15:37:03 UTC
Willie: about 2), I removed the external link.
Comment 11 Frederic Peters 2008-10-27 15:42:19 UTC
Ah, also found the reason behind 1); images are installed in figures/, not images/; links must be updated.
Comment 12 Vincent Alexander 2008-10-27 19:46:19 UTC
The link references have been updated.
Comment 13 Shaun McCance 2008-10-28 00:13:58 UTC
Argh!  I'm sorry.  I named the directory 'figures' to be consistent with all our other docs, full-well knowing that the XML needed to be updated, and then completely forgot to change the XML.  My fault completely.
Comment 14 Willie Walker 2008-10-28 18:35:59 UTC
Just a quick check -- when I look at http://library.gnome.org/devel/accessibility-devel-guide/nightly/gad-how-it-works.html.en, I still see a broken image.  What more should be done to fix it up?

PS - So pysched about all this work.  :-)  I was finally inspired to create a first draft pass at http://www.gnome.org/projects/accessibility/.
Comment 15 Frederic Peters 2008-10-28 19:39:18 UTC
Probably Shaun did the change after the nightly push; I'll check tomorrow.
Comment 16 Vincent Alexander 2008-10-30 16:13:49 UTC
Shaun, Frederic, can we find a proper place to post the Distribution Testing Guide (i.e., under Users, Developers, or Administrators on library.gnome.org) and then get a nightly push going for that as well?
Comment 17 Frederic Peters 2008-10-30 16:25:41 UTC
It just needs a proper Makefile.am to get on library.gnome.org (in the default section, users/); perhaps it could be renamed to distribution-accessibility-testing-guide before ?  (I know the name misled me the first time I saw it).
Comment 18 Willie Walker 2008-10-30 16:29:50 UTC
(In reply to comment #17)
> It just needs a proper Makefile.am to get on library.gnome.org (in the default
> section, users/); perhaps it could be renamed to
> distribution-accessibility-testing-guide before ?  (I know the name misled me
> the first time I saw it).

Thanks Frederic!  Do you guys have an opinion of where it should land?  The target audience are the testing and release engineers of an operating system distribution: "How do I make sure a11y is working properly on my distribution?"

Vince and I are not sure if this applies to users, developers, or administrators.  I'd guess it might apply most to the developers section, but I'm not sure.
Comment 19 Shaun McCance 2008-10-30 19:26:30 UTC
How about just accessibility-testing-guide?  I like somewhat verbose names, but there are limits.

I would consider packagers and distro builders to be a type of developer, I suppose.  Certainly more so than a user or administrator.
Comment 20 Vincent Alexander 2008-11-19 23:41:08 UTC
The nightly push from gnome-user-docs to http://library.gnome.org/users/gnome-access-guide/nightly/low-vision.html.en appears broken; can anyone help?
Comment 21 Frederic Peters 2008-11-20 09:41:09 UTC
Sure; I don't know how it happened but some timestamps went wrong and libgo considered the documentation to be unchanged; I touch'ed the nightly tarball and it is now building correctly.

(feel free to file bugs against library.gnome.org for issues like this)
Comment 22 Vincent Alexander 2008-11-20 15:52:33 UTC
Thanks, Frederic! Moving the project forward. :)