doc writers group for Wiki and how-to
by Karsten Wade
If you want to do any document drafts on the Wiki, please see any of the
people on this page:
http://fedoraproject.org/wiki/DocEditorsGroup
To add you to this page:
http://fedoraproject.org/wiki/DocWritersGroup
This last group has the rights to manipulate pages in the
fp.org/wiki/Docs/Drafts/ tree. Just like CVS, all writers have access
to all documents being worked on.
Golden rule applies: treat other documents as you want your documents
treated.
When a document is ready to be published as a draft, it can be added to
the Docs/ list of documents, under the DRAFTS section. This is done by
an editor.
None of this is a requirement. You can populate the Wiki with any
number of greatly and poorly written documents, at your will. We're
hoping to bring the same level of quality and usefulness to the Docs/
tree as we try for in all Fedora Documentation. This process helps us
to do that, and makes it obvious for readers what is and is not formal
Fedora documentation.
Outside of these directions, we haven't finished developing how
tutorials and guides are laid out in the Wiki. This is something we
discover as we go. As a start, use this page for reference:
http://fedoraproject.org/wiki/DocsProject/WritingUsingTheWiki
Those who are already using the Wiki, please help us to translate our
DocBook usage guidelines into Wiki usage guidelines.
Questions?
- 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, 3 months
Minutes 29 August 2005 FDSCo meeting
by Karsten Wade
Working out scheduling details, much more documentation presence in FC5
release. New colophon thanks you and you and you and you for your
contributions to the release notes.
Want your name to appear in that colophon? Become a relnotes beat
writer!
##################################################
FDSCo meeting
29 August 2005
#fedora-docs, irc.freenode.net
Attendees:
==========
Paul Frields
Tammy Fox
Karsten Wade
Stuart Ellis
Gavin Henry
Mark Johnson
Guests:
=======
None
Regrets:
=======
(Deprecated field)
Updates:
========
The IG is going to be in the GOLD ISO and on the CD, so it needs to
track the release notes cycle
Work on Docs/ and Docs/Drafts/ is ongoing, ACLs should be applied to
those pages soon and we can start experimenting with parent-child
relationships and drafting documentation.
At Elliot's suggestion, we'll hold off on requesting for keyword usage
in commit log messages until the script is written.
Actions:
========
Karsten - Relnotes announcements in usual places
Stuart - Contact Anaconda team for what they think needs to be in the
IG for FC5
Karsten - How is trans for XML diffs v. line diffs? Ready yet?
Karsten - Can trans do the IG in staggers, and fix the differences
later.
Karsten - Update schedule, moving IG out of test1 and inline with
relnotes, including packaging
Paul - Working up a docs package, XML included, yelpify?
Karsten/Stuart - Get a look at some MoinMoin to DocBook output.
Gavin - Write up Wiki page of what to document for relnotes.
Gavin - Start a discussion on recruiting for relnotes beat writers.
## 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, 3 months
Desktop Guide/Moving From Windows to Fedora
by Andy Hudson
Hi all,
I'm currently away on vacation so haven't had much chance to sit down
and do anything with the Moving From Fedora to Windows guide. However
I should get some time to sit down this week and do some writing.
I think there will be a fair amount of cross-over between the Moving
from Windows to Fedora and the Desktop Guide. However, the initial
'Getting Started' is literally an orientation sheet designed to help
new users to get settled into their new OS and provide pointers to
other documentation that will have fuller explanations. I'd like to
think it would be mentioned in the release notes at some point when it
is finished.
Given that this was mentioned as a possible test of the Wiki - does
this mean you want me to write directly into the Wiki and it will be
ultimately transformed into XML?
Finally - it would probably be good if we could mirror the desktop
guide to what people actually want to do with their computers. I added
a line to the Graphics section of the Desktop Users Guide about
Digital Cameras - this is one of the biggest reasons why people use
computers and we should reflect this. I actually could get some access
to research done into why people use their computers and could
summarise this if it would be preferable. The only problem is that it
would be for UK users only - I can't get data on the US. Besides,
we're not *that* different, are we? ;)
Thanks,
Andrew
18 years, 3 months
doc schedule for FC5
by Karsten Wade
Pardon the cross-post, this is important enough to deserve it. :)
This schedule has been discussed with translation, so should fit into
their needs.
This is more than a draft, but there is room for some change if you can
make a good case.
http://fedoraproject.org/wiki/DocsProject/Schedule
Here is the test1 excerpt for discussion:
Test1
24 Oct. Relnote content frozen for trans
28 Oct. Guides content frozen for trans
31 Oct. Relnotes freeze for trans
01 Nov. Relnotes freeze for release (ISO)
02 Nov. Final ISO spin.
04 Nov. Guides trans freeze
05 Nov. Guides frozen for release (Web)
07 Nov. Test1 release
Translation has asked for a week to do appropriate translation. This
will result in up-to-date content missing from the release notes.
Here is how we address that:
* Early requests for relnotes
* Publicize this schedule, no surprises
* First and most prominent link at the top of the relnotes points the
reader at the online version of the relnotes
* This online version will be updated the day of FC release
* Will be in CVS
* Will need translation ASAP
* This helps make the next trans cycle shorter
* Will be posted live in rolling releases
--
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, 3 months
XML style for translation
by Tommy Reynolds
Now as we focus on the translation problems, er,
opportunities, I'd like a definitive answer about this.
Which of the following formatting paragraph styles does the translation team
find more friendly:
When in anger or in doubt, run in
circles, scream and shout. The
quick brown fox jumped over the
lazy dog.
or:
When in anger or in doubt, run in circles, scream and shout.
The quick brown fox jumped over the lazy dog.
Specificly, should each sentence from the source document be:
1) lines justified all together into the semblance
of a paragraph; or
2) a separate line, no matter how long it gets.
Personaly, I prefer #2 where each sentence forms its own formatting
object. This avoids any distractions trying to minic the final
document layout. I've seen diffs that just changed "the end. The",
with two spaces, into "the end. The", with a single space.
Ultimately, the point of XML DocBook is to separate content from
presentation so I could live with either, but I'm no translator.
Well, maybe if you consider redneck-to-english a formal process ;-)
I'm not advocating layout surgery on existing content, but would like
a "best practices" recomendation from the folks who know what they
are talking about.
Cheers
18 years, 3 months
