Documentation

Differences between revisions 29 and 30
Revision 29 as of 2011-01-08 18:44:12
Size: 4547
Editor: 70-139-187-208
Comment: updated some wiki links
Revision 30 as of 2011-01-08 18:50:32
Size: 4543
Editor: 70-139-187-208
Comment:
Deletions are marked like this. Additions are marked like this.
Line 56: Line 56:
When reporting bugs in ''development'' versions of the Xubuntu documentation, please check to make sure that the documentation problem you are reporting has not already been fixed. To do so, you can reference the most recent [[http://doc.ubuntu.com/xubuntu|html builds]] of the documentation (which are refreshed nightly), or (for the more adventurous) the [[https://code.edge.launchpad.net/xubuntu-doc/|source code]] on Launchpad. When reporting bugs in ''development'' versions of the Xubuntu documentation, please check to make sure that the documentation problem you are reporting has not already been fixed. To do so, you can reference the most recent [[http://doc.ubuntu.com/xubuntu|html builds]] of the documentation (which are refreshed nightly), or (for the more adventurous) the [[https://code.launchpad.net/xubuntu-docs/|source code]] on Launchpad.

Introduction

The Xubuntu Documentation project consists of:

  • The Xubuntu system documentation
  • The Xubuntu project wiki (Xubuntu development documentation)
  • Community wiki documentation (community-created end-user support documentation)
  • Release announcements and release notes

Current Focus

System documentation for the 11.04 release is currently under active development. You can view the Roadmap to see our current status and deadlines, and the Assignments page to see individual section responsibilities.

Contributing

There are a number of ways to contribute to Xubuntu documentation. Xubuntu documentors can work on the system documentation, the Xubuntu team wiki pages, release announcements and notes, or the Xubuntu website. You do not need to know how to program to assist with the documentation, but it is helpful to have good writing skills.

The best way to start your involvement is to join the Ubuntu Documentation Contributors team on Launchpad, and then introduce yourself on the Ubuntu documentation team mailing list. From there, a member of the documentation team will contact you to help get you started!

System Documentation

The Xubuntu system documentation consists of both a browser start-page and a complete set of topic-based help. To contribute to the documentation project, review the Documentation Team's primary wiki page and getting started page.

Instructions on how to download and work with the system documentation code is found on the Documentation Team's repository page. All patches should be provided against the latest repository.

Wiki Pages

Information about the Xubuntu Project Wiki documentation may be found here.

Community Documentation

The current community wiki documentation is featured here

Release Announcements & Notes

The Xubuntu documentation team prepares release announcements in advance of Xubuntu development and final releases. Release announcements

Making Suggestions

If you don't feel like learning about the technical stuff (bazaar, DocBook, writing patches), you may also simply read the draft builds of the documentation, and then send texts, ideas & suggestions to either ubuntu-doc@lists.ubuntu.com or xubuntu-devel@lists.ubuntu.com.

Documentation Bugs

To keep track of issues with the documentation, a Xubuntu Documentation Team was created on launchpad.

Regarding bugs, you can use the following links to:

When reporting bugs in finalized, released versions of the Xubuntu documentation, please be sure to reference the version of Xubuntu that you are using (8.04, 9.10, 10.04, etc.).

When reporting bugs in development versions of the Xubuntu documentation, please check to make sure that the documentation problem you are reporting has not already been fixed. To do so, you can reference the most recent html builds of the documentation (which are refreshed nightly), or (for the more adventurous) the source code on Launchpad.

Alternative Documentation

Some people like screencasts as a way of documenting software. There is a "Quick Tour of Xubuntu 6.06" in Flash, which may be found here. Also, check out the Screencast HowTo, or head over to the Screencast Team to learn how to make your own.


Sub-pages :


CategoryDocteam

Xubuntu/Documentation (last edited 2016-03-14 13:58:38 by knome)