Xen Project Document Days
|The Xen Project Wiki has been subject to a severe spam attack in the last several months. To solve this and keep the wiki usable for everyone, we had to lock down the wiki and create an editors group. Please fill out this form and we will add you to the group.|
What is a Xen Project Document Day?
Xen Project document days are all day IRC events, facilitated by members of the Xen Project community. The purpose of Xen Project Document Days is to
- Improve user documentation
- Improve developer documentation, including the creation of man pages, etc.
- Improve and maintaining the wiki: this means fixing important pages, retiring old ones, help identify what is and isn’t important, write new pages, etc.
How Does it Work?
- Request to be a Wiki editor
- Join us on IRC: freenode channel #xendocs
- Tell people what you intend to work on (to avoid doing something somebody else is already working on)
- Fix some documentation
- Help others
- And above all: have fun!
THEME OF THE MONTH: "User Requests"
This month, we will focus on requests which have appeared in our IRC channel and UserVoice for additional documentation. Recent requests include the following (feel free to add additional topics as they appear):
- Development Documentation: An overview of the driver architecture. This may already exist, but it needs to be more prominently visible. If it's out there, it is not as easy to find as it should be.
- User Documentation: Simple example of moving a VM from one machine to another offline and possibly changing toolsets as it goes. Wei recently gave the summary below in ##xen. We need a page with more meat on the bones, particularly for migrating between toolkits and across multiple versions of the hypervisor (e.g., moving from 4.1 to 4.4).
xm save domain image; scp image user@remote:~; scp domu.cfg user@remote:~; modify domu.cfg on remote host; xl restore
- User Documentation: Update to the Xen_Windows_GplPv doc. The drivers are still used, but the information on the page is dated. It needs a refresh.
- Build a NEW HOW-TO describing how to create a Xen 4.5.1 AMD64 environment. This should include sub-HOWTOs for networking and DomU creation.
From Uservoice: All the examples for installing and using Xen are currently antiquated. Can someone just record how they set up a new system using Ubuntu 14/15, Xen 4.5.1, and XAPI/xl? Sections on setting up networking, passthru, BIOS bugs and *NIX/Win/OSX would be exactly what is needed.
- anything else which needs to be added
Other ways to Help
Let us know if you struggled with some content, if something is missing, can be improved and you do not feel sure enough to make changes to a page. The way to do this is by making a comment on talk pages. Every wiki page has an associated talk page which can be used for discussion and communicating with other users. Talk pages can be accessed by clicking the “discussion” tab at the top of the page. Simply edit the page as normal to add your comment, following the conventions outlined in Help:Talk Pages.
Proposed Dates for 2015
Following the modifications we made in 2014 to make Document Day the last Wednesday of the month, this year's proposed dates are as follows:
- January 28, 2015
- February 25, 2015
- March 25, 2015
- April 29, 2015 (moved to May 6 because of the Hackathon)
- May 27, 2015
- June 24, 2015
- July 29, 2015
- August 26, 2015
- September 30, 2015
- October 28, 2015
- December 2, 2015 (due to holidays in November and December in multiple countries)
Some community members indicated that they would like an extra doc day on a public holiday or weekend. We are looking for proposed dates. Please add dates below and sign up besides it. If we get more than 5 people signed up, we should hold a day on a weekend.