Minutes from FDSCo (07 June 2005)
by Karsten Wade
Fedora Documentation Steering Committee (FDSCo)
07-JUN-2005 #fedora-docs on irc.freenode.net
IRC log posted to fedora-dsco-list(a)redhat.com
Attendees:
==========
Karsten Wade (Chair)
Tammy Fox
Gavin Henry
Mark Johnson
Paul Frields
Stuart Ellis
Agenda:
=======
* Release notes really completed
* Installation Guide completed, Karsten still editing
* DOCG meeting tentative for 27 June
New Stuff
* Fedora Bounties
* Stuart's idea
* Others?
* Mether is pursuing a kbase idea
* AOB
* Toolchain update
* XML clean-up
* Red Hat Magazine publicity for FDP
Updates & Notes:
================
* Release notes are gold for FC4.
* Installation Guide will be gold very soon.
* Rahul Sundaram is pursuing a kbase idea. This is seen by FDSCo as a
good way to engage new writers, who can tackle short Q&A style
how-to documentation without needing to learn DocBook. Stuart and
Karsten are providing point contact within FDSCo for this project.
* Mark and Karsten are working on Red Hat documentation toolchain
details that they hope to push out to FDP soon. The intention is to
keep the toolchains lined up, with the stylesheets (XSL and CSS) as
the main difference. No promises yet.
New Actions:
============
FDSCo - review DOCG (Documentation Guide) ideas for 28 June meeting.
FDP - decide upon common documentation files structure (Paul will post
the initial thread).
Karsten - create f.r.c/docs/release-notes/ and populate with all
historical release notes, as released and errata where
appropriate
Karsten - Do a final edit on Installation Guide.
Karsten - Tag final IG files as FC-4.
Karsten - Publish edit and publish IG.
Karsten - Connect whoever works on DocBook Wiki with Sopwith for
infrastructure discussions.
Karsten - Give some interview coverage about FDP and FDSCo. [PR]
Paul - Take discussion of docs-common/ to list.
Paul - Looking into XML programs to post-process code and clean it up
(indenting, whitespace) on the server side. This deals with
normalizing the server side where we can't control the client
(writer) side.
Paul - After 17 June to post a reminder about upcoming DOCG discussion
on 28 June.
Gavin - Early stab at DOCG details.
Stuart - Email f-docs-l about screencast bounty idea
Stuart - Follow up with developers of screenasting tools
Stuart - Input one or more bounties into FedoraBounties
## 30
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
Imported into CVS - "Updating Your Desktop with up2date"
by Stuart Ellis
Tracking Bug: 155180
This is now in CVS as the module "desktop-up2date".
Note that this is a revised and renamed version of the "Using Up2date"
tutorial. Hopefully pup will eventually make this of historical
interest, but up2date is likely to be in use on some systems for a long
time to come...
Post-import test checkout and build worked successfully.
--
Stuart Ellis
stuart(a)elsn.org
Fedora Documentation Project: http://fedora.redhat.com/projects/docs/
GPG key ID: 7098ABEA
GPG key fingerprint: 68B0 E291 FB19 C845 E60E 9569 292E E365 7098 ABEA
18 years, 11 months
changes in legalnotice entity (was Re: common legalnotice-content-en.xml, NONE, 1.1 legalnotice-relnotes-en.xml, NONE, 1.1 fedora-entities-en.ent, 1.2, 1.3 legalnotice-en.xml, 1.8, 1.9)
by Karsten Wade
The below check-in supports a different style of doing the legalnotice
for the release notes.
We need the full relnotes in one page (no chunks), but pulling the
legalnotice in at the top above the ToC is ugly. It defeats our new
What's New section (from Rahul) that makes this a more useful default
homepage for Firefox.
You shouldn't have to change anything, even after doing a 'cvs up' in
common/. Your document's call to &LEGALNOTICE; will continue to do the
right thing.
Changes to the legalnotice now need to happen in common/legalnotice-
content-en.xml.
The changes below do the following:
* Pull the actual content of the legalnotice into a file
common/legalnotice-content-en.xml
* Have legalnotice-en.xml call in the entity &LEGALNOTICE-CONTENT;
* Have legalnotice-relnotes-en.xml give a one line reference to the GFDL
and link to an <appendix>
* Within the relnotes, the new <appendix> has a call to &LEGALNOTICE-
CONTENT;
* fedora-entities-en.ent now has ENTITY declarations for LEGALNOTICE-
CONTENT and LEGALNOTICE-RELNOTES
If you get this update and have *not* changed your document to call
fedora-entities-en.ent (instead of fedora-entities-en.xml), this update
will break your build. The entities file declares the special
legalnotice content file, and this change is *not* in the deprecated
fedora-entities-en.xml file.
Final note: this is a hackish trick. It is not semantically correct,
having the content of the legalnotice _outside_ of the <legalnotice />
container. At least, it feels wrong to me.
I'll look into solving this in the XSL later. Even moving the
legalnotice to appear below the ToC will be good enough.
cheers - Karsten
On Thu, 2005-06-02 at 23:43 -0400, Karsten Wade wrote:
> Author: kwade
>
> Update of /cvs/docs/common
> In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv17035
>
> Modified Files:
> fedora-entities-en.ent legalnotice-en.xml
> Added Files:
> legalnotice-content-en.xml legalnotice-relnotes-en.xml
> Log Message:
> This is just a little hackish. With the legalnotice inline, it ruined the effect of the new release notes style and what's new content. These changes, plus changes to the relnotes parent, pull a special relnotes legalnotice in that has a single sentence and links to an appendix with the full legalnotice content. This is not semantically correct, there must be a way to handle this in the XSL so that the legalnotice content is properly contained throughout. This hack can stand until I find the XSL fix, because sometimes Pretty is more important than Right.
>
>
> --- NEW FILE legalnotice-content-en.xml ---
>
> <para>
> Permission is granted to copy, distribute, and/or modify this document under
> the terms of the GNU Free Documentation License, Version 1.2 or any later
> version published by the Free Software Foundation; with no Invariant
> Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the
> license is available at <ulink
> url="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</ulink>.
> </para>
>
> <para>
> This document may be copied and distributed in any medium, either
> commercially or noncommercially, provided that the GNU Free Documentation
> License (FDL), the copyright notices, and the license notice saying the GNU
> FDL applies to the document are reproduced in all copies, and that you add
> no other conditions whatsoever to those of the GNU FDL.
> </para>
>
> <para>
> Garrett LeSage created the admonition graphics (note, tip, important,
> caution, and warning).
> Tommy Reynolds <email>Tommy.Reynolds(a)MegaCoder.com</email> created the callout graphics.
> They all may be freely redistributed with documentation
> produced for the &PROJECT;.
> </para>
>
> <para>
> &BOOKID;
> </para>
>
> <para>
> &RH;, &RH; Network, the &RH; "Shadow Man" logo, RPM, Maximum RPM, the RPM logo, Linux
> Library, PowerTools, Linux Undercover, RHmember, RHmember More, Rough Cuts,
> Rawhide and all &RH;-based trademarks and logos are trademarks or registered
> trademarks of &FORMAL-RHI; in the United States and other countries.
> </para>
>
> <para>
> Linux is a registered trademark of Linus Torvalds.
> </para>
>
> <para>
> Motif and UNIX are registered trademarks of The Open Group.
> </para>
>
> <para>
> Intel and Pentium are registered trademarks of Intel Corporation. Itanium
> and Celeron are trademarks of Intel Corporation.
> </para>
>
> <para>
> AMD, AMD Athlon, AMD Duron, and AMD K6 are trademarks of Advanced Micro
> Devices, Inc.
> </para>
>
> <para>
> Windows is a registered trademark of Microsoft Corporation.
> </para>
>
> <para>
> SSH and Secure Shell are trademarks of SSH Communications Security, Inc.
> </para>
>
> <para>
> FireWire is a trademark of Apple Computer Corporation.
> </para>
>
> <para>
> All other trademarks and copyrights referred to are the property of their
> respective owners.
> </para>
>
>
> --- NEW FILE legalnotice-relnotes-en.xml ---
> <!-- $Id: -->
> <!--
> <!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
> "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
>
> <!ENTITY BOILERPLATE "This header makes editing XML easier" >
>
> ]>
> -->
> <legalnotice id="legalnotice">
> <para> This document is released under the terms of the GNU Free Documentation
> License. For more details, read the full legalnotice in <xref
> linkend="ax-legalnotice" />.
> </para>
> </legalnotice>
>
>
> Index: fedora-entities-en.ent
> ===================================================================
> RCS file: /cvs/docs/common/fedora-entities-en.ent,v
> retrieving revision 1.2
> retrieving revision 1.3
> diff -u -r1.2 -r1.3
> --- fedora-entities-en.ent 31 May 2005 23:49:51 -0000 1.2
> +++ fedora-entities-en.ent 3 Jun 2005 03:43:08 -0000 1.3
> @@ -45,6 +45,8 @@
>
> <!-- ************** common doc files *********** -->
> <!ENTITY LEGALNOTICE SYSTEM "./legalnotice-en.xml">
> +<!ENTITY LEGALNOTICE-CONTENT SYSTEM "./legalnotice-content-en.xml">
> +<!ENTITY LEGALNOTICE-RELNOTES SYSTEM "./legalnotice-relnotes-en.xml">
>
> <!-- ************** common applications? *********** -->
>
>
>
> Index: legalnotice-en.xml
> ===================================================================
> RCS file: /cvs/docs/common/legalnotice-en.xml,v
> retrieving revision 1.8
> retrieving revision 1.9
> diff -u -r1.8 -r1.9
> --- legalnotice-en.xml 30 May 2005 20:30:27 -0000 1.8
> +++ legalnotice-en.xml 3 Jun 2005 03:43:08 -0000 1.9
> @@ -8,76 +8,5 @@
> ]>
> -->
> <legalnotice id="legalnotice">
> -
> - <para>
> - Permission is granted to copy, distribute, and/or modify this document under
> - the terms of the GNU Free Documentation License, Version 1.2 or any later
> - version published by the Free Software Foundation; with no Invariant
> - Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the
> - license is available at <ulink
> - url="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</ulink>.
> - </para>
> -
> - <para>
> - This document may be copied and distributed in any medium, either
> - commercially or noncommercially, provided that the GNU Free Documentation
> - License (FDL), the copyright notices, and the license notice saying the GNU
> - FDL applies to the document are reproduced in all copies, and that you add
> - no other conditions whatsoever to those of the GNU FDL.
> - </para>
> -
> - <para>
> - Garrett LeSage created the admonition graphics (note, tip, important,
> - caution, and warning).
> - Tommy Reynolds <email>Tommy.Reynolds(a)MegaCoder.com</email> created the callout graphics.
> - They all may be freely redistributed with documentation
> - produced for the &PROJECT;.
> - </para>
> -
> - <para>
> - &BOOKID;
> - </para>
> -
> - <para>
> - &RH;, &RH; Network, the &RH; "Shadow Man" logo, RPM, Maximum RPM, the RPM logo, Linux
> - Library, PowerTools, Linux Undercover, RHmember, RHmember More, Rough Cuts,
> - Rawhide and all &RH;-based trademarks and logos are trademarks or registered
> - trademarks of &FORMAL-RHI; in the United States and other countries.
> - </para>
> -
> - <para>
> - Linux is a registered trademark of Linus Torvalds.
> - </para>
> -
> - <para>
> - Motif and UNIX are registered trademarks of The Open Group.
> - </para>
> -
> - <para>
> - Intel and Pentium are registered trademarks of Intel Corporation. Itanium
> - and Celeron are trademarks of Intel Corporation.
> - </para>
> -
> - <para>
> - AMD, AMD Athlon, AMD Duron, and AMD K6 are trademarks of Advanced Micro
> - Devices, Inc.
> - </para>
> -
> - <para>
> - Windows is a registered trademark of Microsoft Corporation.
> - </para>
> -
> - <para>
> - SSH and Secure Shell are trademarks of SSH Communications Security, Inc.
> - </para>
> -
> - <para>
> - FireWire is a trademark of Apple Computer Corporation.
> - </para>
> -
> - <para>
> - All other trademarks and copyrights referred to are the property of their
> - respective owners.
> - </para>
> -
> +&LEGALNOTICE-CONTENT;
> </legalnotice>
>
> --
> Fedora-docs-commits mailing list
> Fedora-docs-commits(a)redhat.com
> https://www.redhat.com/mailman/listinfo/fedora-docs-commits
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 11 months
fedoraproject.org
by Patrick W. Barnes
I'm not clear on this. Who is responsible for http://fedoraproject.org/
? I'm not sure how many people actually use this base URL, but it needs
some loving. One of the links is broken, and it could be more
informational.
One idea that I had is that this URL could redirect to
http://fedoraproject.org/wiki/ and that the Wiki's front page could
feature all of the existing links, with a brief description. This would
allow easier maintenance, and would automagically make the page more useful.
With Red Hat announcing the creation of The Fedora Foundation, it seems
like Fedora's information will eventually move away from
fedora.redhat.com to its own domain. I don't know if this would be
fedoraproject.org or something entirely different. If the migration is
to fedoraproject.org, then my above suggestion would not create any
problems. Simply removing the redirect and dropping content similar to
fedora.redhat.com would be acceptable. The Wiki and the rest of the
fedoraproject.org hierarchy would not conflict with the content
currently at fedora.redhat.com, and links could be added to whatever
main page is at the base URL to direct people to the current
fedoraproject.org content. If anyone needs any clarification on my
thinking, drop me a line.
For reference, the broken link currently at http://fedoraproject.org is
the 'Fedora FAQ pages at homelinux' link, which points to
http://fedoraproject.org/faq , which redirects to
http://fcp.homelinux.org/modules/wffaq when it should redirect to
http://fcp.homelinux.org/modules/smartfaq .
--
--
Patrick "The N-Man" Barnes
nman64(a)n-man.com
www.n-man.com
--
18 years, 11 months
Minutes from FDSCo (31 May 2005)
by Karsten Wade
Fedora Documentation Steering Committee (FDSCo)
31-MAY-2005 #fedora-docs on irc.freenode.net
Attendees:
==========
Karsten Wade (Chair)
Tammy Fox
Gavin Henry
Paul Frields
Stuart Ellis
Agenda:
=======
* FC4 Release notes status
* FC4 Installation Guide status
* Documentation Guide thoughts (time coming soon)
* Tools status
New Actions:
============
FDP: Separate release notes by arch to be tackled for FC5test1, will
discuss viability first, tabled for a few weeks
Karsten: Karsten to post final FC4 relnotes to wiki.
FDP: List needs to consider packaging documentation for FC5. RPMs for
documents:
* Separate RPMs per manual?
* One or separate SRPMs?
* htmlview useful, not a dependency?
* yelp connection?
FDP: Post your ideas for the Documentation Guide to Wiki:
http://fedoraproject.org/wiki/DocsProject/DocumentationGuide
* Work on this guide to continue within a few weeks
* Paul will call for a DOCG focused meeting for the FDSCo, probably
28 June
FDP: Documentation Project focus is on making the toolchain work on
current base release plus released updates.
* DocBook wiki might help resolve disparate systems problems
FDP: Writer's different environments causing small problems already.
* Can we post process somewhere in the CVS commits chain?
cf. indent for C
* How can we use xmldiff
Karsten: Discuss xmldiff and post-processing of XML with Elliott
Paul: Documentation Guide example tutorial shall illustrate almost
everything in the Documentation Guide itself.
Updates/Status:
===============
* Release notes
* New process went well
* Beats all worked out, XML infrastructure in place, making next
time easier
* Installation Guide
* Never complete, but shippable
* Can the IG appear next to README for FC4? (follow up: no)
* XSL patched to support no chunks
* Thanks to James Laska
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 11 months
Self-Introduction: Arun Mallikarjunan
by Arun Mallikarjunan
Hi All,
I joined the list a few days back and was confused as to how
to start when I saw Patricks email. So here goes.
My name's Arun Mallikarjunan. I have been using Linux for
sometime now and even though I haven't contributed much towards
development efforts I have been promulgating it all I can. I even
convinced my roommates to switch.
I would like to contribute to the Linux community anyway
possible. I felt the best way to start would be by learning it and
understanding the concept better and what's better than writing the
documentation to learn it.
I would be glad if somebody can act as a mentor and guide me
through the open source process as I am not too familiar with it, and
point me in a direction where I can start leveraging my skills which by
the way are J2EE, C and C++. I am working as a project lead for NGB in
Washington DC.
Looking forward to be a part of the team.
Regards,
Arun
18 years, 11 months
Self-Introduction: Patrick W. Barnes
by Patrick W. Barnes
About Me:
My name is Patrick W. Barnes
My Internet nickname is "The N-Man", and thus my name will usually
appear as 'Patrick "The N-Man" Barnes'
I live in Amarillo, Texas (USA)
I am a Systems Administrator for CTL Technologies
My Goals and Qualifications:
I have been using, testing, monitoring, and assisting other users and
developers with the Fedora Project for some time now, and I would like
to start making more active contributions.
I would like to help with the Fedora Project in as many ways as
possible. I have a variety of useful skills. I currently distribute
the Fedora Core releases on systems my company sells, and have a great
deal of exposure to end-user feedback. We also use Fedora Core releases
and the Rawhide branch internally. I am a programmer and a web
designer, as well as a system and network administrator. I am also an
excellent writer, and that is the skill that I would like to contribute
with first.
I hope to improve documentation and tutorial options for users who are
new to Linux and Fedora. I would also like to contribute to the
user-friendly qualities of Fedora Core. My wide variety of skills and
experience will allow me to write on a large variety of topics. I do an
excellent job of staying on top of emerging technologies and changes
occuring within the project.
To start things off, I'd like to help in organizing the existing
information in the Extras wiki and making the wiki more concise to
reduce errors and questions and improve productivity. First, I would
like to write a quick page to field some of the questions regarding
Google's Summer of Code and provide information about high-interest,
unmaintained (or missing) projects. Please let me know if there are any
questions. I look forward to contributing.
GPG data:
pub 1024D/299407D8 2004-11-04 [expires: 2009-11-03]
Key fingerprint = 5379 7B24 8A9D 2105 450F 6D20 741A 01EC 2994 07D8
uid Patrick W. Barnes <n-man(a)n-man.com>
uid Patrick W. Barnes <nman64(a)n-man.com>
uid Patrick W. Barnes <n-man(a)ctltechnologies.net>
sub 2048g/9BDA9ED4 2004-11-04 [expires: 2009-11-03]
This message has been sent to both fedora-extras-list and fedora-docs-list.
--
Patrick "The N-Man" Barnes
nman64(a)n-man.com
www.n-man.com
--
18 years, 11 months
Re: Google's Summer of Code (new documentation submission)
by Bill Nottingham
Patrick Barnes (nman64(a)n-man.com) said:
> I am interested in getting a page published to assist Google's Summer of
> Code participants in getting started. Fedora is one of the few mentors
> on the Summer of Code page at Google that does not have a link for ideas
> or to help participants get started. I have written a first draft and
> published it to http://fedora.n-man.com/projects/GoogleSummer.txt . I
> think that the Wiki would be the best place for this, but others might
> think differently. The draft document is plain text, but has been
> written with hyperlinks in mind.
>
> Since I don't know where this will go, and it will require a new page to
> be created either way, I don't know how to proceed. Should I try for
> Docs CVS access or Wiki write access? Who can decide where this page
> should go, and can create the page? Any comments, suggestions, or
> directions would be appreciated.
>
> This message has been posted to fedora-docs-list and fedora-extras-list.
See http://fedoraproject.org/wiki/FedoraBounties
Bill
18 years, 11 months
Re: Fedora-docs-commits Digest, Vol 2, Issue 46
by Karsten Wade
(moving over to f-docs-l)
On Thu, 2005-06-02 at 09:08 -0400, Paul W. Frields wrote:
> On Mon, 2005-05-30 at 16:52 -0400, fedora-docs-commits-
> > Index: html-common.xsl
> > ===================================================================
> > RCS file: /cvs/docs/xsl/html-common.xsl,v
> > retrieving revision 1.6
> > retrieving revision 1.7
> > diff -u -r1.6 -r1.7
> > --- html-common.xsl 17 May 2005 15:51:17 -0000 1.6
> > +++ html-common.xsl 30 May 2005 20:01:11 -0000 1.7
> > @@ -25,7 +25,10 @@
> >
> > <xsl:output method="html" indent="no"/>
> >
> > +<!--
> > +disable for FC4
> > <xsl:param name="generate.legalnotice.link" select="1"></xsl:param>
> > +-->
> >
> > <xsl:param name="html.stylesheet" select="'fedora.css'"></xsl:param>
> > <xsl:param name="html.stylesheet.type">text/css</xsl:param>
> >
> >
> >
> > ------------------------------
>
> Is there a reason this changed in the common area and not as some sort
> of xsl override for the release notes? Sure uglies up the Install
> Guide....
I made a special XSL chain for just the release notes and removed the
legalnotice link, then returned the call to the standard XSL toolchain.
Update to the latest Makefile for the relnotes (also unique) and xsl/,
I'll be testing today but let me know if any more problems arise.
- Karsten
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 11 months
