Wiki: Fedora Quick Install Guide

Eric H. Christensen eric at christensenplace.us
Mon Dec 19 15:44:09 UTC 2011


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Sun, Dec 18, 2011 at 12:14:03PM -0500, Ben Cotton wrote:
> As we discussed in the Docs meeting earlier this week[0], I spoke with
> Valentin about the overlap between the Installation Quick Start Guide
> and the wiki page he developed[1]. He seems to favor the wiki for this
> document, and the translation team has expressed support[2].
> 
> Considering we've failed to get the IQSG out for the past two
> releases, I'm inclined to suggest we retire that guide in favor of the
> wiki page so that the docs team can focus on other guides and the
> yet-to-be-agreed-upon QA process.
> 
> Thoughts?
> 
> [0] http://meetbot.fedoraproject.org/fedora-meeting/2011-12-12/fedora_docs.2011-12-12-14.00.log.txt
> [1] https://fedoraproject.org/wiki/Fedora_Quick_Install_Guide
> [2] http://lists.fedoraproject.org/pipermail/trans/2011-December/thread.html
> 

At today's meeting we discussed this and I believe we were in agreement that the IQSG should remain in DocBook XML and have updates provided to it from the wiki.

We've really spent a lot of time developing our workflow.  The wiki is a great collaborative sandbox in which to develop material that will later become formalized.  The problem with the wiki is it is too difficult to find things there (among other problems).  Our end-users know that our guides can be found in one place: docs.fp.o.  We need to maintain that user friendliness and not start spreading our bits out all over the place which was the problem we had before.

If development needs to happen on a guide and the contributor isn't well versed in DocBook XML then the wiki is a fine place to hack on the words.  For the final product, however, that hacked source should be moved to DocBook and included in the existing source.  This is basically how the Release Notes are created for every release and doesn't add a lot of work to the entire process.

I'm really not sure why DocBook seems to be inflict fear into people.  It really isn't all that difficult to use and the end result is hands down more useful than wiki text.  That said, if you don't know how to write in DocBook may I suggest that we do a virtual class on this similar to what we are planning for FUDcon Blacksburg?  I know we've had classes before that were well attended and successful.

In the interim, I'll be looking at the changes that are being proposed on the wiki for the IQSG and will start working on incorporating them into the DocBook source.

- -- Eric

- --------------------------------------------------
Eric H Christensen        eric at christensenplace.us
"Sparks"                  sparks at fedoraproject.org
   .... .. .-.. .-.. ---   .-- --- .-. .-.. -..
097C 82C3 52DF C64A 50C2  E3A3 8076 ABDE 024B B3D1
- --------------------------------------------------
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)

iQIcBAEBCAAGBQJO71vJAAoJEIB2q94CS7PR2H0QAJuWkQjf6KzUteSQvE6C2KHa
sSASIgy5tFqQ1/yEa2dfvE8YKglnkQ6GhPza9dB5Rw1IP87sFA7BPgDWEfUrrTnD
SbMnTbYNwyQ9sqyEqGmCud+bP7sTWjtvxMQ56Ab0M46i2P9ymxV87t04wGvHhE6E
6QDa682Ik04XcVuxpdxp5XQhuKLSLpZBqxUObJPSYxjOQiyEZ8nXeCGxnvyTK91i
NmlynHpWltJlVlqAtQOEbwDDjI42Kl28/p9GLfyzVo+UrA61uau0snL6OT67EoWi
RTLSklHHaoej6/SiKsA+SR+LkTd7CPP2KFHu7QTBsszhiVIBD71UZQszSZF4ioH/
qUMp1mdk2eEh/L6TA4lyuOvE1LrzRK8VGVqGE3D2a99mI+Rd+RZN3zsK6ps+UzCl
XpMO2k/4M9ZXhd2z/UgE8ODgS88MoG2HQfX6aSY6G+N23LiC12hqjhE/aLHbjsT+
dchJl9CMcsXtOrjWG0nzU/VvjsNpnG2ZBVYlyr8dkmm8cn26qEXKFrbGaqZjdJkf
6iP0KKkIur5mDX7nEhDoGWMXUzwCZZpdDOdvCAOQEH2WblR2kuZ04kVYJ+kKT9Vj
ar7mmSNgTSIdk91IJ/Q2TqZWE8EYliLkHI2U888hUY1fFzPuNQjpXGzzlY44yplG
TH2cixmv+tNieF+bsMia
=phRK
-----END PGP SIGNATURE-----


More information about the docs mailing list