DocsProject wikispace reorganization [RFC]
by Bart Couvreur
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hey *,
in spite of the recent "Docs Project Structure" mail, I've been trying
to get my head around the wiki-space we own.
People who want to see how - should I call it unorganized? - our
project's pages are, go to the DocsProject page and add anything to the
url that doesn't exist, it'll give you a list of all pages beneath
DocsProject/ (e.g. fp.o/wiki/DocsProject/foo)
So here's a reorganization proposal:
DocsProject/
|-- Join
| |--Writer
| |--Editor
| \--Translator
|-- Goals / Mission
|-- Schedule
| \--some pages with details (e.g. specific schedules on DUG, IG)
|-- Tasks (considering all FDP related tasks and processes)
| |--Guides
| |--Relnotes
| |--Browser splash page
| |--Plone
| |--Ideas-page
| \--Release announcement (not sure if we should do this)
|-- FDSCo (or steering committee)
| |--Charter
| |--Meeting minutes
| |--Elections
| |--Nominations
| \--Task Schedule
\-- Workflow
|--Docbook (how to write + intro)
|--CVS (usage)
|--Wiki (how to write)
|--Publishing (web, PDF?)
\--Tools
And some general ideas:
a) Create a default template for all Docs-related pages on the wiki
(breadcrumb, default header, ...) to create a common look-and-feel
b) Move everything in /Docs/Drafts to DocsProject/Drafts so users know
that everything in /Docs is published documentation.
As I said, it's all just an idea / proposal. Comments?
Bart
- --
Bart <couf(a)fedoraproject.org> <couf(a)skynet.be>
key fingerprint: 6AAB 544D 3432 D013 776D 3602 ADB6 6B2A D93F 0F93
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org
iD8DBQFF6HPFrbZrKtk/D5MRAundAJ4mfftwtgspoZZBb2y8yXn2zRlqmwCeMDUT
FXP6QRJZlJNCaM7in+JooEI=
=Yi2v
-----END PGP SIGNATURE-----
17 years, 1 month
pump up the mailing list
by Karsten Wade
$SUBJECT is an idiom for, "Make bigger, better, faster, and more
popular."
Just a reminder to those of us who do lots of stuff together on IRC to
at least send a note on discussion outcomes back to the list. Thus:
09:47 < quaid> mailing-list-over-IRC++
09:47 < quaid> at least, we should make an effort to turn our discussions into
short notes to the list, "We just discussed Foo on IRC and ..."
09:47 < quaid> has the effect of giving us a common place to keep notes (the
list) and hopefully attract more people here :)
cheers - Karsten
--
Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project
Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject
quaid.108.redhat.com | gpg key: AD0E0C41
////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
17 years, 1 month
PDF format guides
by Rahul Sundaram
Hi
I would like to have our guides like the Installation one in PDF format.
Is there any quick way to get them?
Rahul
17 years, 1 month
Yet another PDF export tool -- WikiPublisher
by Dimitris Glezos
And here is our interesting-new-tool-of-the-week. :)
Trying to find something similar to `doc-book.sf.net` I stumbled upon
WikiPublisher [1]:
[1]: http://www.wikipublisher.org
It's basically a plugin for 'pmwiki' that outputs a 'WikiBook XML' and a server
that converts this syntax to PDF. This allows to ouput a PDF from any wiki page
*and* create whole books based on inter-wiki links. You can try this by clicking
Typeset book at [2]:
[2]: http://www.wikipublisher.org/wiki/index.php?n=Wikipublisher.UserGuide
The server is written in Perl and uses Latex to do the job. To use it, we'd need
to write a plugin for Moin to export to the Wikibook XML and run the Perl server.
Pros:
* Backend is upstream and actively developed
* Customizable PDF
* Backend is in Perl (not PHP)
Cons:
* Requires yet another export mechanism
* Backend is in Perl (not Python)
* DocBook out of the way -- how to do translations??
-d
--
Dimitris Glezos
Jabber ID: glezos(a)jabber.org, GPG: 0xA5A04C3B
http://dimitris.glezos.com/
"He who gives up functionality for ease of use
loses both and deserves neither." (Anonymous)
--
17 years, 1 month
promoting Docs/Beats as relnotes for test3
by Karsten Wade
Since test3 is also going to be a one-sheet for release notes, how does
this idea sound?
* At the top of the one-sheet (F7Test2/ReleaseNotes) we put a link to
Docs/Beats and explain the content is alpha ('alphabet soup'), sort of
the rawhide of release notes content source.
* Include this link in the announcement sent about the one-sheet
* Promote on support channels (#fedora, fedoraforum.org, fedorafaq.org,
etc.)
Pros
----
Brings more attention to the raw notes, which brings more contributors.
Gets more important information out to more people sooner (release
early, release often.)
Many eyes make fewer technical and grammatical errors.
Makes our jobs easier while doing a better service.
Other?
Cons
----
Unpolished portions of the Wiki pages may reflect negatively on Fedora
Documentation or the Fedora Project in general.
Technical errors may cause user computers to eat themselves, or worse,
get expelled.[1]
Very empty notes such as we often have in the middle of testing can be
quite embarrassing. :)
Other?
- Karsten
[1] Movie-reference-trivia-link-of-the-week: http://us.imdb.com/title/tt0241527/quotes
--
Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project
Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject
quaid.108.redhat.com | gpg key: AD0E0C41
////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
17 years, 1 month
h1 in Wiki
by Karsten Wade
I've lost track of what we want to appear as a primary header (h1) on a
Wiki page. That is, we sometimes use this:
{{{#!html
<h2>Page Title</h2>}}}
Is this strictly for visual affect?
In the case of the Docs/Beats, I think we need to stick to a strict
usage of each page having only one h1 and all other content being a sub:
= Page Title =
== A Section ==
=== Sub-section A ===
=== Sub-section B ===
== Another Section ==
According to this page:
http://fedoraproject.org/wiki/DocsProject/WritingUsingTheWiki
... that is our method.
Seem reasonable?
- Karsten
--
Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project
Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject
quaid.108.redhat.com | gpg key: AD0E0C41
////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
17 years, 1 month
[Fwd: Election Results]
by Karsten Wade
Thanks to all of you who voted. The top four vote receivers hold their
seats (voluntarily) for twelve months. The next three have their seats
up for re-election in six months; they of course may run for their seat
again at that time.
After the next election in six months, we can review as a group if we
like to do twice-yearly or yearly elections for FDSCo.
Nominees -- thanks again for stepping up. You rock. Keep up the good
work you know that you do.
- Karsten
-------- Forwarded Message --------
Results for the Fedora Documentation Steering Committee February 2007
Votes | Candidate
------+----------------------------
20 | Paul W. Frields pfrields
18 | Karsten Wade kwade
17 | Dimitris Glezos glezos
16 | Robert 'Bob' Jensen bjensen
14 | John Babich jmbabich
10 | Pawel Sadowski mcgiwer
10 | Bart Couvreur couf
7 | Gavin Henry ghenry
--
Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project
Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject
quaid.108.redhat.com | gpg key: AD0E0C41
////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
17 years, 1 month
Clearing out release notes
by Paul W. Frields
I'd like to suggest that we take the Docs/Beats/* pages, and strip out
all existing data up through the original FC6 final release. Any
remaining content is likely fresh enough for F7 release. That way, we
don't risk contributors coming in to the "alpha" release thinking
there's no work to do when there's really quite a bit.
I will volunteer to help if we can get enough +1's.
--
Paul W. Frields, RHCE http://paul.frields.org/
gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717
Fedora Project: http://fedoraproject.org/wiki/PaulWFrields
irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
17 years, 1 month
Docs Project Structure?
by Griff 5watt
I just recently got involved in the Docs Project and while getting my head
into it all, I had a few thoughts. Please let me know if I am missing
something.
I read through the information in the wiki and did not see anywhere an
explicit mission statement about the Docs Project. Specifically what I was
looking for was information as to who the documentation was geared for. The
'Documentation' link on the front page of the Fedora Project wiki brings up
an unclear picture of the documentation as well. The designation between
the target audiences is not clearly defined, flowing from [End User]
Published Documents and Draft Documents right into New Contributors and
Developers.
>From what I have seen, there are three major categories that documentation
falls under. 1) The End User [defined below]; 2) The Developer; 3) Other
contributors.
For me, the End User is the person looking to install and use Fedora
Linux. This person may be a home user doing email and watching videos on
the web; or the office worker doing email, documents and spreadsheets; or
the administrator supporting the office worker; or the web developer who is
doing their work on Linux. [+1]
Those who are involved in the development of Fedora Linux or contribute in
other ways are separate from the End User. There was some talk at FUDCon
about dividing the front page into three sections... End User, Contributor,
Developer. Documentation should follow this division as well.
If the real focus currently is the End User, then the main documents
required are:
- The Installation Guide (How do I get Fedora Linux onto my machine?)
[available on fedora.redhat.com/docs/]
- The Desktop Users Guide (Now, what can I do with this default install?)
[available from the fedoraproject.org wiki]
- System Maintenance (How can I keep it running well?) [not available?]
- Software Installation (How can I get more applications that will hose my
system?) [available? from fedora.redhat.com/docs/ 'Managing Software with
YUM']
- and Support (What do I do to solve my problem?) [not available?] [+2]
Are there documents for Maintenance and Support?
Anyway, I am going to get back to reading what is currently out there and
try to be a constructive member of the group.
------------------------
1) I expect that our sponsor would prefer that the Office Worker, Developer
and the Administrator end-users would be using RHEL rather than Fedora
Linux, otherwise they would be eager for Fedora to provide a server spin,
thereby negating the need for the Fedora Project to handle this
documentation. However, if Fedora is truly to provide the base for RHEL,
then this would include documentation for these users. This requires more
direction from the appropriate people. This leaves us with the Home User.
2) In my view this document would start out with a brief list of those tools
that would be helpful in trouble shooting problems, and how to use
them. Then a list of external sites would be provided that would allow the
user to research their individual issue on their own, i.e. fedoraforum.org,
linuxforums.org, and linuxquestions.org.
--
Aaron Bowman, Fedora Docs Wannabe
gpg fingerprint: 2DD4 471F 12F4 FB93 986F 2B41 17DB 3139 CBF6 2385
17 years, 1 month
