Man page website
by Eric Christensen
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
A few weeks ago we received a ticket[0] asking about publishing man
pages for Fedora on the Internet. We know that there are other man
pages out there however we have found that they may not be up to date
with the versions that are in Fedora.
The overall opinion, that I've seen, is that this would be something
that might be worthwhile *if* we can script the entire process.
Does anyone have any ideas for doing this or have any opinions on
doing this?
[0] https://bugzilla.redhat.com/show_bug.cgi?id=828669
- -- Eric
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Fedora Project - https://fedoraproject.org
Member of:
* Fedora Board
* Documentation Project
097C 82C3 52DF C64A 50C2 E3A3 8076 ABDE 024B B3D1
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.12 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQIcBAEBAgAGBQJQFpckAAoJEIB2q94CS7PRh7QQAM502sPhVP9dam0LA5Uxc/q6
Va6d10Yo1/8mg5tnlyt+FSvdpW8hOziilrV8yxuXfZ6ezOAoo9BUH3TvIVoqud4a
Rw+VzEA3n6ZEChR4jYlMP7LyNQ9gVu70ucPquQ1Kp/AHcRtC2ZfNvaPWKHJRQjxK
xQLwbK0+kmXL/7VZLW7hBBKi5kDEzFiP+rwGA25Ebpikoy82RWPpUsE3iiFXtssn
TktApfk0/LXs6ZzO29mFVsZB4ylzrH3//nxTKzeMrfI9b6BgeZ0L03XT+Azwlzeu
7A5ApgYN0SepFaW1NSN5Zw6M77kxTnU7B9fZsM5kyVv9Y7ZxpRMziSSMd47jXpnt
Lovcp3mKDIIXb5PS7/el7Ml8KNAzFOF7NpuHLB8obwNUS2DTe9QloY1AQG4vF1W4
OWqdg8nRvY/8LJQNuIAuPnmJJ8LqNz1BXZarRW88hCxS+WnR5srNdw4I0ggaVz7T
ZNeZKvUxaEVw2KnCsImgBmiEhEaxDJ4L3KSNXITplZjlu06CZaJo2gKaHECGYqA1
7EFdPTkY+j5zYDhR6xFafi9qs41GlyR8+jb6hiJjGNRkWsFmmGwU9AhXWVlQYCGt
feS3t02MzW+aRExt/3TktXr0QixvEwGMllLbTLRGpD70xH/xn2woeeTkvufLAPWv
kIDIKwQFcdKxTRp4TAlR
=H1Pr
-----END PGP SIGNATURE-----
11 years, 9 months
Docs meeting summary -- 30 July 2012
by Ben Cotton
Meeting summary
---------------
* Roll Call (bcotton, 14:00:23)
* Follow up on last week's action items (bcotton, 14:05:35)
* ACTION: Sparks to take man page website to mailing list (bcotton,
14:07:35)
* ACTION: ianweller to ask the guys behind the packages app if man
pages is a thing they can do (bcotton, 14:08:53)
* ACTION: bcotton to send call for volunteers for QA Wrangler to
mailing list (bcotton, 14:09:15)
* Using koji to publish docs.fp.o (bcotton, 14:09:27)
* LINK: https://fedoraproject.org/wiki/Automating_publishing
(bcotton, 14:09:34)
* Publish man pages (bcotton, 14:10:38)
* LINK: https://bugzilla.redhat.com/show_bug.cgi?id=828669 (bcotton,
14:10:50)
* QA recap (bcotton, 14:13:53)
* LINK: https://fedoraproject.org/wiki/Docs_QA_Procedure (bcotton,
14:13:59)
* ACTION: Sparks to add relevant git commands to QA procedures
(bcotton, 14:22:17)
* Open Help Conference (bcotton, 14:29:38)
* LINK: http://openhelpconference.com (bcotton, 14:29:49)
* Open Help Conference is Aug 11-15 in Cincinnati, OH (bcotton,
14:29:56)
* Outstanding BZ Tickets (bcotton, 14:30:54)
* now would be a good time to get bugs fixed before we start working
on F18 (bcotton, 14:32:51)
* Open floor discussion (bcotton, 14:34:27)
* HELP: (jhradilek, 14:36:05)
* HELP: mr zodbot (Capesteve, 14:36:20)
* HELP: - Add a "Call for Help" to the minutes. Use this command when
you need to recruit someone to do a task. (Counter-intuitively, this
doesn't provide help on the bot) (nirik, 14:36:57)
* LINK: http://wiki.debian.org/MeetBot/ and
http://meetbot.debian.net/Manual.html (nirik, 14:38:26)
Meeting ended at 14:40:46 UTC.
Action Items
------------
* Sparks to take man page website to mailing list
* ianweller to ask the guys behind the packages app if man pages is a
thing they can do
* bcotton to send call for volunteers for QA Wrangler to mailing list
* Sparks to add relevant git commands to QA procedures
Action Items, by person
-----------------------
* bcotton
* bcotton to send call for volunteers for QA Wrangler to mailing list
* Sparks
* Sparks to take man page website to mailing list
* Sparks to add relevant git commands to QA procedures
* ianweller
* ianweller to ask the guys behind the packages app if man pages is a
thing they can do
People Present (lines said)
---------------------------
* bcotton (61)
* Capesteve (20)
* randomuser (8)
* Sparks (6)
* jhradilek (6)
* shaiton (5)
* nirik (4)
* lnovich (4)
* zodbot (3)
* pkovar (1)
Minutes:
http://meetbot.fedoraproject.org/fedora-meeting/2012-07-30/fedora_docs.20...
Minutes (text):
http://meetbot.fedoraproject.org/fedora-meeting/2012-07-30/fedora_docs.20...
Log:
http://meetbot.fedoraproject.org/fedora-meeting/2012-07-30/fedora_docs.20...
--
Ben Cotton
Fedora Docs Leader
11 years, 9 months
Fedora Docs Meeting Reminder
by Ben Cotton
This is an automated message to remind you that we will be meeting at 1400 UTC in #fedora-meeting. Unless we've previously agreed that we will not be meeting today.
11 years, 9 months
Guide editing workflow: How to efficiently work with docs, translators and publishers
by Kévin Raymond
Heya!
Short summary: Discussing before switching the translation system of some
guides.
After spending many hours in the merge issue between our old teams and the
transifex.net ones, it is still an active task.
Thanks to involved contributors, it is moving forward, there are already some
projects fully merged.
Willing to help with the IQSG (installation quick start guide), I noticed an
issue in the transifex config[1], which leads me to a zanata config file and the
corresponding git commits.
A bit of history.
A while back, we were using our own Transifex instance, which was not sticking
to the upstream releases. It was a mess with projects unavailable and other
issues.
There were 2 solutions:
- Migrating to transifex.net, the online hosted service maintained by the
Transifex team,
- Moving to an other system (in our infra or somewhere else).
Some wanted to try Zanata. There where a RH instance set for this purpose[2].
After many discussions, it has been decided to move all our projects to
transifex.net.
Few upstream projects choose for specific reasons to move to an other service,
and even to Zanata (1 or 2). And few others just stops dealing with translations.
Yes, changing the translation platform is a pain for both, maintainers and
translators.
Nowadays, we are close to have fully integrated all projects to transifex.net
(still some merge concerning docs[3]).
So here we are, with translations done through transifex.net for the projects
correctly set up, the other one needs attention ([4]?).
/end of history
The IQSG is not correctly set up.
But we just saw on the git log
"* fb03c3c Adding zanata config file"
this is… weird without other notice.
On the Zanata instance, we could see:
Description Creation Date Status
Fedora Installation Quick Start Guide 19 juin 2012 Active
Fedora Installation Guide 19 juin 2012 Active
I just asked more info on IRC, and it appears that we need to discuss/define how
we deal with our translation platform, and let our maintainers explain why they
need to move somewhere else.
nb has reverted the ZANATA commits in the above guides, to avoid mistakes.
@maintainers, could you please explain your needs/wishes?
Cheers,
[1] https://bugzilla.redhat.com/show_bug.cgi?id=836383
[2] https://translate.zanata.org/zanata/
[3] http://lists.fedoraproject.org/pipermail/docs/2012-June/014356.html
[4] http://lists.fedoraproject.org/pipermail/docs/2012-June/014420.html
--
Kévin Raymond
(Shaiton)
11 years, 9 months
Converting PyDoc to Docbook XML?
by Steve Gordon
Hi all,
Has anyone attempted converting PyDoc to Docbook XML recently with success? I've tried a project called HappyDoc but it seems to be unmaintained and pretty poorly documented, though it claims on the project site to be able to generate DocBook XML.
I have also tried generating the PyDoc HTML with `pydoc -w <module>`, converting it to XHTML with tidy:
tidy -indent -m -asxhtml -clean -bare -omit ovirtsdk.infrastructure.brokers.html
...and then turning it into Docbook with an XSLT [1]:
java -cp "/usr/share/java/xalan-j2.jar" org.apache.xalan.xslt.Process -XSL html2db.xsl -IN <module>.html > <module>.xml
The resulting XML still has a *lot* of errors according to XMLLINT, even before applying the DTD rules. Anyone had any success with a variation of this or maybe a different method entirely?
Thanks,
Steve
[1] http://osteele.com/software/xslt/html2db/
11 years, 9 months
Fwd: Welcome to the "docs" mailing list
by Miguel A. Cervantes
---------- Forwarded message ----------
From: <docs-request(a)lists.fedoraproject.org>
Date: 2012/7/18
Subject: Welcome to the "docs" mailing list
To: mkcervantes01(a)gmail.com
Welcome to the docs(a)lists.fedoraproject.org mailing list! For
information about being a writer or editor, read this page:
http://fedoraproject.org/wiki/DocsProject/NewWriters
To post to this list, send your email to:
docs(a)lists.fedoraproject.org
General information about the mailing list is at:
https://admin.fedoraproject.org/mailman/listinfo/docs
If you ever want to unsubscribe or change your options (eg, switch to
or from digest mode, change your password, etc.), visit your
subscription page at:
https://admin.fedoraproject.org/mailman/options/docs/mkcervantes01%40gmai...
You can also make such adjustments via email by sending a message to:
docs-request(a)lists.fedoraproject.org
with the word `help' in the subject or body (don't include the
quotes), and you will get back a message with instructions.
You must know your password to change your options (including changing
the password, itself) or to unsubscribe. It is:
hiwaatoc
Normally, Mailman will remind you of your lists.fedoraproject.org
mailing list passwords once every month, although you can disable this
if you prefer. This reminder will also include instructions on how to
unsubscribe or change your account options. There is also a button on
your options page that will email your current password to you.
11 years, 9 months
[Bug 842456] New: Python documentation not available as GTK-doc through devhelp
by Red Hat Bugzilla
https://bugzilla.redhat.com/show_bug.cgi?id=842456
Bug ID: 842456
QA Contact: docs(a)lists.fedoraproject.org
Severity: unspecified
Version: devel
Priority: unspecified
CC: eric(a)christensenplace.us, oglesbyzm(a)gmail.com,
stickster(a)gmail.com
Assignee: nobody(a)fedoraproject.org
Summary: Python documentation not available as GTK-doc through
devhelp
Regression: ---
Story Points: ---
Classification: Fedora
OS: Unspecified
Reporter: nekohayo(a)gmail.com
Type: Bug
Documentation: ---
Hardware: Unspecified
Mount Type: ---
Status: NEW
Component: docs-requests
Product: Fedora Documentation
Even with the "python-docs" package installed, I can't look at the Python docs
through "devhelp" or "yelp. It would be nice for contributors to have easy
access to offline programming documentation.
--
You are receiving this mail because:
You are the QA Contact for the bug.
11 years, 9 months
Docs meeting summary -- 23 July 2012
by Ben Cotton
Meeting summary
---------------
* Roll Call (bcotton, 14:00:54)
* Follow up on last week's action items (bcotton, 14:06:06)
* ACTION: Sparks to take man page website to mailing list (bcotton,
14:07:29)
* ACTION: ianweller to ask the guys behind the packages app if man
pages is a thing they can do (bcotton, 14:07:38)
* Using koji to publish docs.fp.o (bcotton, 14:07:56)
* List discussion
https://lists.fedoraproject.org/pipermail/docs/2012-May/014324.html
(bcotton, 14:08:04)
* LINK: https://fedoraproject.org/wiki/Automating_publishing
(bcotton, 14:08:11)
* Publish man pages (bcotton, 14:10:22)
* QA recap (bcotton, 14:12:07)
* LINK: https://fedoraproject.org/wiki/Docs_QA_Procedure (bcotton,
14:12:13)
* ACTION: bcotton to send call for volunteers for QA Wrangler to
mailing list (bcotton, 14:26:54)
* AGREED: if nobody volunteers, randomuser` will take the QA Wrangler
role (bcotton, 14:27:08)
* Open Help Conference (bcotton, 14:30:04)
* LINK: http://openhelpconference.com (bcotton, 14:30:12)
* Open Help Conference is Aug 11-15 in Cincinnati, OH (bcotton,
14:30:22)
* Outstanding BZ Tickets (bcotton, 14:33:15)
* LINK: http://tinyurl.com/lbrq84 (bcotton, 14:33:33)
* there are many open bugs. now is a good time to clear those up
before life gets busy for F18 (bcotton, 14:34:20)
* bug squashing is a good way for new contributors to get involved
(bcotton, 14:35:10)
* Open floor discussion (bcotton, 14:36:20)
Meeting ended at 14:49:58 UTC.
Action Items
------------
* Sparks to take man page website to mailing list
* ianweller to ask the guys behind the packages app if man pages is a
thing they can do
* bcotton to send call for volunteers for QA Wrangler to mailing list
Action Items, by person
-----------------------
* bcotton
* bcotton to send call for volunteers for QA Wrangler to mailing list
* **UNASSIGNED**
* Sparks to take man page website to mailing list
* ianweller to ask the guys behind the packages app if man pages is a
thing they can do
People Present (lines said)
---------------------------
* bcotton (62)
* randomuser` (25)
* lnovich (6)
* sgordon (3)
* zodbot (3)
* chuckf (2)
* jjmcd (1)
* pkovar (1)
Minutes:
http://meetbot.fedoraproject.org/fedora-meeting/2012-07-23/fedora_docs.20...
Minutes (text):
http://meetbot.fedoraproject.org/fedora-meeting/2012-07-23/fedora_docs.20...
Log:
http://meetbot.fedoraproject.org/fedora-meeting/2012-07-23/fedora_docs.20...
--
Ben Cotton
Fedora Docs Leader
11 years, 9 months
Fedora Docs Meeting Reminder
by Ben Cotton
This is an automated message to remind you that we will be meeting at 1400 UTC in #fedora-meeting. Unless we've previously agreed that we will not be meeting today.
11 years, 9 months
