Bug 130125
|
Description
Paul W. Frields
2004-08-17 11:41:02 UTC
Created attachment 103314 [details] Tarball ready for editorial process This is the up-to-date tarball, hopefully ready for editorial at this point. The nightly HTML build (0400 US/Eastern time) is available at <http://docs.frields.org>. Created attachment 103389 [details]
New version, mirror-tutorial-0.21
This version makes a couple minor correction and brings some markup in line
with recent fedora-docs-list discussion (hopefully).
Created attachment 103519 [details]
New version, mirror-tutorial-0.22
Some additional cleanup. I think this is ready for editorial. *fingers
crossing*
Karsten, want to edit this one? Created attachment 103603 [details] New version, mirror-tutorial-0.23 A few style edits, more voice slippage (sorry, Karsten). Apologies for the repeated attachments, since I'm not sure exactly when someone will get around to editing this. If you have doubts, see http://svn.frields.org to pull down a tarball. Okay, I'll take it from here ... I've started reading it already, but hadn't made any edits yet. I'll start editing this afternoon/evening (PDT), bug me by Thursday afternoon (PDT) if you haven't heard any status, please. :) Mark Johnson recently created a good format for the introduction <section>: http://people.redhat.com/mjohnson/docs/fedora/docbook-emacs-quickstart/index.html#about What do you think about adopting that template for your introductions? It goes like this: 1. Introduction 1.1 Purpose 1.2 Audience 1.3 About <Technology> ... 1.x Additional Resources 1.x+1 Acknowledgements Each sub <section> only needs a paragraph or a few sentences. Thoughts? I'd like to get a proper introduction template for all other tutorials to use, if we can. Absolutely. Let me take care of that part, hopefully today if possible. I may have time at lunch break (in RHS 333 class today) to take care of this, and put version 0.24 up for you. Created attachment 103643 [details]
New version, mirror-tutorial-0.24
This version includes a new introduction. I only covered an "About
<technology>" section for the concept of mirrors. I felt that the idea of
up2date, RHN, and yum were somewhat peripheral to the real mission of the
tutorial, which was actual provision of a mirror. The tutorial covers these
technologies from the perspective of how to use the mirror once it's set up.
Let me know if you disagree with my rationale.
Created attachment 103655 [details]
mirror-tutorial.xml 0.24 + changes
Whoops ... we'll have to have some clear protocols about doing handoff and
document locking so we don't step on each other's toes. I had a bunch of
little changes to the 0.23 version, so I manually merged in your additions in
0.24. I don't think I missed anything, and I put a <!-- note --> where two
paragraphs had been removed to ask if you meant that. IIRC, they were useful
background paragraphs.
Couple of notes on my changes so far ... <emphasis> should only be used where
you are giving something special emphasis, but not enough to make an admonition
(Note, Tip, etc.). Similar with <quote>, that you only want to use it when
quoting someone or something. I tried to find meaningful tags to use. One
that troubles me is the URL that is not a <ulink> such as host.example.com. It
might be best to untag it ... I looked through Red Hat docs and found several
usages, so there isn't really a best one. Similar is <filename> for a package;
in this case, <package> has been accepted for the next version of DB, so we can
change that later ...
If you do a 'diff -u oldfile newfile' the changes should be fairly clear.
There was one section where I converted an <itemizedlist> to <variablelist> so
the changes are one big block, but the rest should be clear.
Just to avoid confusion, hold off on further changes until I get done with the
edit (today).
Right about the document locking. Sorry that created a problem. I thought I moved a couple paragraphs into the introduction where they made more sense. I guess my use of <quote> was misguided in what I suspect is a common error for people who haven't been DocBooking for very long... using it to create curly quotes instead of ugly straight ones. :-) I didn't realize I <ulink>'d an example URL. Thinking back, I remember having a thought that there should be a tag for a host name used as content instead of in a real hyperlink. I probably tagged it thinking I'd remember to fix it. Always a bad move! I'll look forward to seeing your work. BTW, hope it's acceptable to thread this discussion inside Bugzilla in this fashion. It does mean, at least, that the issues won't be lost to the ages inside my Evo folders. Karsten, were you able to finish those edits? In answer to your <!-- note --> about those two paragraphs, they were moved to the Introduction section where they made more sense, in the "About Mirrors" section. It seems to me that is the place for very rudimentary definitions of the technology that will be covered in the body of the tutorial. I used some material by Mark Johnson as a guide. Created attachment 105139 [details]
New version, mirror-tutorial-0.25
This final version incorporates all changes by KWade. I would consider this
ready for publication once it passes final muster by Tammy. I am going to
unblock the progress tracker and block the publication tracker; sorry this has
taken me so long.
Created attachment 105161 [details]
Corrected version, mirror-tutorial-0.25
*sigh* I forgot to edit the version entity in the last attachment, sorry!
Tammy, any word on this tutorial? I have a newer version with some very slight revisions to address FC3 and createrepo, but I am not attaching them yet to avoid any confusion. Tickle, tickle, tickle! Hi Paul. Sorry for the delay. We were working 100% on the magazine and then I got strep throat during Thanksgiving. If you attach your newer version I'll be sure to get it posted this week. Promise. ;-) Created attachment 107712 [details] New version, mirror-tutorial-0.26 I hope you're feeling better now. This is a freshly minted tarball of the current version. You can see changes at: http://www2.frields.org:8080/viewcvs/mirror-tutorial/mirror-tutorial-en.xml?rev=89&r1=79&r2=89 Created attachment 107713 [details]
New version, mirror-tutorial-0.27
Of course I found some additional errors. Corrected here in version 0.27.
Hopefully no one downloaded 0.26 in the last 30 minutes. :-)
Err, tickle, tickle again! Created attachment 110418 [details]
New version, mirror-tutorial-0.28
A couple additional very minor typos. Ready and awaiting final trip through
editorial...
This has been in beta for some time. Is this ready for publishing? Let's clear out this cobwebby bug... Publish that puppy. I think we need to look for cruft in our processes and clear that out, too. Shouldn't be letting good tutorials hang around. All right, that's done and tagged. Can you do me a favor and update the web module's include/navigation.inc file? I don't have access to that one but it just needs a link inserted in the array. Ticket moved to allow products to be removed from BZ. |