David Zeuthen and the Live CD Team:
I think it would help promote the Fedora Live CD efforts if there was a HOWTO (based on the README) which could be easily referenced and updated as needed in the Fedora Project wiki.
In order to do this, I converted the README for the Live CD Tools into a formatted wiki entry under my sandbox, http://fedoraproject.org/wiki/JohnBabich/Sandbox/LiveCDHowTo.
I would like to move it to http://fedoraproject.org/wiki/FedoraLiveCD/LiveCDHowTo.
I am willing to track changes in the Live CD process and update the wiki accordingly. Please let me know if you agree and I will link the HOWTO under the FedoraLiveCD entry and take responsibility to keep it up-to-date.
John Babich Volunteer, Fedora Docs Project
On Sun, 2007-01-14 at 15:43 +0300, John Babich wrote:
David Zeuthen and the Live CD Team:
I think it would help promote the Fedora Live CD efforts if there was a HOWTO (based on the README) which could be easily referenced and updated as needed in the Fedora Project wiki.
In order to do this, I converted the README for the Live CD Tools into a formatted wiki entry under my sandbox, http://fedoraproject.org/wiki/JohnBabich/Sandbox/LiveCDHowTo.
I would like to move it to http://fedoraproject.org/wiki/FedoraLiveCD/LiveCDHowTo.
I am willing to track changes in the Live CD process and update the wiki accordingly. Please let me know if you agree and I will link the HOWTO under the FedoraLiveCD entry and take responsibility to keep it up-to-date.
John Babich Volunteer, Fedora Docs Project
Great work, John. if the LiveCD folks need SCM-maintained documentation, perhaps a good compromise would be using Docs CVS. I'm not sure that's a great solution, but it's certainly available.
This is the kind of situation that we had envisioned Plone solving -- documents could be registered in any of a variety of SCMs, edited through the Web interface, stored appropriately in the back end as DocBook XML, and converted to other formats as needed. Our vision hasn't yet resulted in anyone stepping up to do that work (which is, in all honesty, a substantial project), but Karsten just presented this as one of the issues at the recent Board meeting¹.
¹ http://fedoraproject.org/wiki/Board/Meetings/2007-01-09
On Sun, 2007-01-14 at 15:43 +0300, John Babich wrote:
I am willing to track changes in the Live CD process and update the wiki accordingly. Please let me know if you agree and I will link the HOWTO under the FedoraLiveCD entry and take responsibility to keep it up-to-date.
OK, it makes sense as project-specific documentation, especially if you find a way to tie it directly to the README. That is, get the LiveCD project to accept the Wiki as the upstream they derive the README from.
Regardless, you can link this document from either the Docs/Drafts/ or Docs/ page, depending on readiness. How about this ... get one other person to read your work as an editor (wordsmith), then link it from Docs/.
- Karsten
On 1/16/07, Karsten Wade kwade@redhat.com wrote:
OK, it makes sense as project-specific documentation, especially if you find a way to tie it directly to the README. That is, get the LiveCD project to accept the Wiki as the upstream they derive the README from.
Regardless, you can link this document from either the Docs/Drafts/ or Docs/ page, depending on readiness. How about this ... get one other person to read your work as an editor (wordsmith), then link it from Docs/.
Since Thomas Chung gave me the go-ahead, I took that as agreement that my initial plan to move it directly under the LiveCD wiki entry was the way to go.
Therefore, I moved it to that location. I viewed it as a "donation" to the Live CD project, just like I did some summaries for the "Extras" project. Of course, it is a living document, so I promised to "adopt" it by keeping it in sync with any future READMEs.
It was essentially a wikification of a README , so I viewed it differently from the Software Management Guide, for example.
I guess it comes down to the best way to maintain the doc. I just saw it as a very valuable piece of information that should be published quickly, which will be subject to a lot of rapid revisions - perfect for a Wiki entry. Once the Live CD Tools are stable, then, I agree, there should be a more formal procedure in place.
If you think we can do both at once - rapid updates and storing it as DocBook - I'm OK with that, but I will need a bit of assistance until I get the process down.
John Babich
docs@lists.stg.fedoraproject.org
-
John Babich -
Karsten Wade -
Paul W. Frields