The time has come to convert the beats on the wiki[1] into docbook and
commit them into release-notes.git . Participation from anyone in
docs-writers would be appreciated.
When you begin migrating a beat, begin by changing the wiki header from
{{Docs_beat_open}} to {{Docs_beat_closed}} . This will signal to other
writers that someone is working on it, and let potential contributors
know we are done trawling that wiki page for new content. The Beats
Category page also has a progress table to mark completion - but for
best results, if you start converting a wiki page, please see it
through. The structure definitely won't match the layout of the Beats
pages when we're done, so finding half-finished beats isn't straightforward.
Please also take the opportunity to verify, correct, and improve the
content. I think a release note best serves the reader when it covers
the following points, however briefly:
- What is the software's function?
- How has that function changed?
- How does the user experience the software or new capability (ie
example commands, installation instructions)
- Where can the user find more information about the software?
(Upstream sites, manpages, etc. Basically, cite your references)
Since potentially many of us could be working on this, communication
will be important. Remember to pull before you start, and keep in sync
by committing often, and performing push/pull after every commit. I
intend to be in #fedora-docs whenever working on it, and I've filed a
ticket[3] asking infra to announce our commits in the channel.
When we're done with the migration, Self-contained Changes are next, and
that's not a trivial effort, so let's knock it out quickly.
[1]
https://fedoraproject.org/wiki/Category:Documentation_beats?rd=Docs/Beats
[2] https://git.fedorahosted.org/cgit/
[3] https://fedorahosted.org/fedora-infrastructure/ticket/4555
--
-- Pete Travis
- Fedora Docs Project Leader
- 'randomuser' on freenode
- immanetize@xxxxxxxxxxxxxxxxx
Attachment:
signature.asc
Description: OpenPGP digital signature
-- docs mailing list docs@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe: https://admin.fedoraproject.org/mailman/listinfo/docs
