GNOME Bugzilla – Bug 556500
[gadg] port to gnome-doc-utils
Last modified: 2008-11-20 15:52:33 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?
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?
It will be svn+ssh://username@svn.gnome.org/svn/gnome-devel-docs/trunk/gadg/C/ ; I'll make the move now.
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.
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.
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).
The name change sounds great to me -- if you can make this happen, I'd really appreciate it.
Done. Vincent, you'll find your work in accessibility-devel-guide now.
Thanks, Shaun.
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.
Willie: about 2), I removed the external link.
Ah, also found the reason behind 1); images are installed in figures/, not images/; links must be updated.
The link references have been updated.
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.
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/.
Probably Shaun did the change after the nightly push; I'll check tomorrow.
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?
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).
(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.
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.
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?
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)
Thanks, Frederic! Moving the project forward. :)