https://wiki.xenproject.org/api.php?action=feedcontributions&user=Lisa.Nguyen&feedformat=atomXen - User contributions [en]2024-03-29T13:40:55ZUser contributionsMediaWiki 1.31.3https://wiki.xenproject.org/index.php?title=Xen_Document_Days/TODO&diff=9770Xen Document Days/TODO2013-09-30T14:54:44Z<p>Lisa.Nguyen: /* Manpages for xe command */</p>
<hr />
<div>{{WarningLeft|The Xen Wiki has been subject to a severe spam attack in the last few days. To solve this and keep the wiki usable for everyone, we had to lock down the wiki and create an editors group. Please [http://xenproject.org/component/content/article/100-misc/145-request-to-be-made-a-wiki-editor.html fill out this form] and we will add you to the group.}}<br />
----<br />
Go back to [[Xen Document Days]]<br />
<br />
== Requested Documentation ==<br />
<br />
{{InfoLeft|Feel free to comment on items using the following convention:<br />
<pre>* {{Comment|~~~~:}} your comment</pre><br />
Feel free to add new workitems using the following convention:<br />
<pre>==== Workitem ====<br />
~~~~: work-item description<br />
</pre>}}<br />
<br />
=== (IMPORTANT) XenAPI OpenStack Documentation ===<br />
See [https://blueprints.launchpad.net/openstack-manuals/+spec/redocument-xen related blueprint]<br />
<br />
=== (IMPORTANT) Linux Distros ===<br />
It seems that the list of Linux Distros which support Xen is a lot larger than listed on this wiki. <br />
* [http://www.funtoo.org/Xen Funtoo]<br />
* [https://wiki.mageia.org/en/XEN Mageia]<br />
* Are there others?<br />
The following pages need updating and new categories need to be created:<br />
* [[Dom0_Kernels_for_Xen]]<br />
* [[DomU_Support_for_Xen]]<br />
* [[Template:Distro_Resources]]<br />
* Add categories<br />
<br />
=== (IMPORTANT) Lose ends for transition from Mercurial to Git ===<br />
<br />
Pages that need fixing<br />
* [[XenParavirtOps]]<br />
* [[Xen_On_Funtoo_From_Scratch]]<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 13:46, 29 January 2013 (UTC):}}<br />
* [[Compiling Xen From Source]] {{Tick}}<br />
* [[Submitting Xen Patches]] {{Tick}}<br />
* [[Submitting_Xen_Patches_with_Git]] has been created<br />
* Marked pages with TODO's<br />
<br />
=== Restructure XCP Related Categories ===<br />
* This is executing the proposal http://lists.xenproject.org/archives/html/xen-api/2013-06/msg00109.html [Proposal for input] Disentangling XAPI, XAPI packages and XCP on wiki.xenproject.org]. In a nutshell:<br />
* Category XCP : only use for content specific to the XCP ISO<br />
* New Category XAPI Project : this is basically a category for developers<br />
* New Category XAPI Users : this is basically for users of XAPI, XAPI packages in distro and other flavours of XAPI (e.g. XCP ISO when not specific to the ISO)<br />
* Move content into those locations<br />
<br />
=== Xen 4.3 Documentation ===<br />
<br />
==== Xen 4.3 Release Notes ====<br />
Need to flesh out [[Xen_4.3_Release_Notes]] (also see [[Xen_4.2_Release_Notes]])<br />
<br />
==== Spice Config Example for upstream QEMU ====<br />
Take [http://lists.xenproject.org/archives/html/xen-users/2013-06/msg00423.html this thread] and convert into an Example<br />
<br />
=== In progress (some just need double checking whether finished) ===<br />
<br />
==== Better XCP Overview Documentation ====<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 08:02, 25 September 2012 (UTC):}} See [[XCP Overview]] & [[XCP Release Features]] - these need a little bit more work<br />
<br />
<br />
<hr><br />
<br />
=== Easy tasks for Beginners ===<br />
You may weant to read [[Help:Contents|Wiki Help]] if you do not have an account.<br />
<br />
==== Migrate useful blog posts to wiki ====<br />
Sift through blog.xen.org and copy useful posts to wiki. This will mainly be a reformatting exercise. Before you copy an article, perform a search on the wiki (headline or key word) to see whether the post exists already. If in doubt, ask on the IRC channel.<br />
<br />
==== Fix articles that need attention ====<br />
* [[:Category:Contains_Needs_Formatting]] - Pages that need formatting<br />
* [[:Category:Contains_Needs_Action]] - Pages that need fixing. Go through these, and if you get stuck ask people on the IRC channel for help, or go to the next page.<br />
* [[:Category:Contains_TODO]] - Pages that have a TODO item on the page. Go through these, and if you get stuck ask people on the IRC channel for help, or go to the next page.<br />
<br />
==== Review Categorization ====<br />
* Sometimes new pages on the wiki are not created with categories. You can find these by going to [[Special:UncategorizedPages]]. Documentation about which category is used where can be found in [[Categories for Authors]]. If in doubt ask on IRC.<br />
<br />
==== Pages With Comments or Improvement Suggestions ====<br />
* We ask users to highlight issues using '''talk pages''', following the conventions outlined in [[Help:Talk Pages]]. Comments made using these conventions can be identified using the [[:Category:Pages with comments]].<br />
<br />
==== Missing Pages ====<br />
* [[Special:WantedPages]] - You can find missing pages by going to this link. There are several courses of actoin that can be taken:<br />
** The page is needed : Add <code><nowiki>{{TODO|With a comment}}</nowiki></code> to the top of the page<br />
** The page is not needed : Remove the reference to the page (follow the link in the bracket besides the page)<br />
** Note that the list of Wanted pages contains lots of needed translations and categories, which you can ignore<br />
** If in doubt, ask for help on the IRC channel<br />
<br />
{{Comment|[[User:Double-p|Double-p]] 09:55, 25 February 2013 (UTC):}} There are a gazillion Template-Whatever including a TODO, really needed? <br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 17:40, 25 March 2013 (UTC):}} See [[#Special:WantedPages_broken]]<br />
<br />
<hr><br />
<br />
=== Xen : Open work items ===<br />
<br />
==== UEFI Secure Boot ====<br />
Write a document on how to sign the xen binary for UEFI Secure Boot. Potential reference here: [http://www.rodsbooks.com/efi-bootloaders/secureboot.html Dealing With Secure Boot]<br />
<br />
==== Manpages for xe command ====<br />
Write manpages for xe and its 430 subcommands. <br />
* A team led by [[user:GrantMcWilliams|Grant McWilliams]] and including [[user:Matthew.Spah|Matthew Spah]], [[user:Lisa.Nguyen|Lisa Nguyen]] and [[user:MRWebberOne|Mike Webber]] is currently working on documenting the xe command and will continue to do so until completed. Moving the source repo to xen-org has been [[http://lists.xen.org/archives/html/xen-api/2012-09/msg00053.html proposed]].<br />
* As of September 2013, the [http://xenapiadmin.com Xenapi Admin Project] team is currently automating the manpage creation process for all xe subcommands.<br />
<br />
==== Describe the different ways, and necessary components, to create PVs using xl ====<br />
Raised by mail by ''Matthias Blankenhaus'' (who is prepared to take the lead, but needs help):<br />
This document would describe the different ways, and necessary components that each way requires, to create PVs using xl. Right now there are at least the following cases:<br />
* loopbacked vhds<br />
** single partition format<br />
** disk format<br />
* qemu backed vhds<br />
** qcow / qcow2<br />
* LVS backed image<br />
<br />
This is not a complete list. Also the mileage of each case differs depending on the kernel features enabled in dom0/domu and also depending on the Xen version. Furthermore, certain format require additional infrastructure like the tap device. <br />
<br />
All in all, this a complex topic that needs clarification. Doing this based on the lowest common denominator, xl, would clarify many things. In addition, baseline performance data on all of the above would help a great deal. Matthias volunteered to run the majority of needed perf tests<br />
<br />
==== Review and Update: xenpm usage recommendations ====<br />
There is [[Xen power management]] and [[Xenpm command]] which may all be outdated. These should probably be reviewed and updated.<br />
<br />
==== HOWTO : using xm trigger to poweroff or firing off NMIs ====<br />
Howto on using xm trigger to poweroff or firing off NMIs.<br />
<br />
==== HOWTO : How to Set Up Nested Virtualization ====<br />
See [http://lists.xen.org/archives/html/xen-users/2012-10/msg00311.html this thread]<br />
<br />
==== HOWTO: Chain pypxeboot and pygrub====<br />
How to chain [http://sourceforge.net/projects/pypxeboot/ pypxeboot] and pygrub <br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 10:35, 27 March 2012 (UTC):}} Is pypxeboot popular at all?<br />
* {{Comment|[[User:Fheigl|Fheigl]]:}} I added that. It is somewhat common, OVM 2 and OVM 3 rely on it for PXE installs. I'm not sure if xenpvnetboot is the same, or works. The use case is "you want to use the same installation server for Xen VMs and phys. servers. You want to be able to reinstall them based on PXE reply.<br />
* {{Comment|[[User:Fheigl|Fheigl]]:}} There is documentation for pypxeboot, but there is no (afaik) documentation for how pygrub is used as a fallback loader. We wasted many days just to get some hack that can't even load a newer kernel. Which sucks, in the end you spend more time/money making PV PXE boot work than you save by using virtualized servers.<br />
* {{Comment|[[User:Fheigl|Fheigl]]:}} How could it be popular given the state of documentation. <= Key issue to the left of this sentence.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:03, 19 September 2012 (UTC):}} wondering whether [https://vimeo.com/46125332 this video] contains what is needed<br />
<br />
<hr><br />
<br />
==== Openvswitch ====<br />
<br />
[[Network Configuration Examples (Xen 4.1+)]] for Openvswitch systems. How to configure guests. [[Xen_Networking]] updates. Perhaps a standalone page.<br />
<br />
=== XCP : Open work items ===<br />
<br />
==== XCP Beginners Guide ====<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 15:32, 28 January 2013 (UTC):}} We are missing the equivalent of the [[Xen Beginners Guide]] for XCP.<br />
* {{Comment|[[User:Double-p|Double-p]] 09:39, 25 March 2013 (UTC):}} see [[XCP Beginners Guide]] for review/additions<br />
<br />
==== Make titles of XCP and XAPI documentation consistent ====<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 13:09, 28 January 2013 (UTC):}} Often XCP related docs do not have XCP in the title, this makes it hard to find XCP related documents in titles. This is really hurting XCP users. Maybe this needs to be followed through in page categorisation also. Here is my proposal:<br />
* XCP related user documents should start with <code><nowiki>XCP:</nowiki></code><br />
* Design documents - these are design documents should probably be labelled <code><nowiki>Component-Name:</nowiki></code>, e.g. <code><nowiki>XAPI:</nowiki></code>, etc.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:36, 28 January 2013 (UTC):}} Would need to take [[#Visually_distinguish_Xen.2C_XCP_and_Community_Documentation_better|the next item]] into account. In other words using '''XCP:...''', '''XCP:XAPI:...''', etc. would make more sense and would allow implementing namespaces later.<br />
<br />
'''Also see:'''<br />
* [http://lists.xen.org/archives/html/xen-api/2013-01/msg00223.html Proposal on xen-api list]<br />
<br />
==== Visually distinguish Xen, XCP and Community Documentation better ====<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 15:32, 28 January 2013 (UTC):}} Users are getting confused when looking at wiki pages. If there was a visual way to distinguish Xen, XCP and Other content better, this would help. We could use colors and skinning when it comes to various elements, as well as masocts/logos:<br />
* For example: [[Help:Contents]] has a different feel (and colour scheme)<br />
* This could be replicated in trail boxes and other elements<br />
* We can also use mascots (note we don't have an XCP mascot)<br />
<br />
'''But first, I need to investigate what is possible.'''<br />
<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 16:14, 28 January 2013 (UTC):}} Looks as if the only way this can be done is via [http://www.mediawiki.org/wiki/Manual:Using_custom_namespaces Custom Namespaces]. The only way to do this properly is to <br />
* Have different namespaces for Xen, XCP, ... and Community stuff and keep all the common stuff in Xen<br />
* The name spaces could then be styled differently, for example the '''Help''' namespace includes the '''ns-12''' style into the body attributes, whereas the '''Main (default)''' namespace uses the '''ns-14''' style. <br />
* Custom namespaces can be created by changing the config and are linked to custom styles<br />
* The styles are then defined in [[MediaWiki:Common.css]]<br />
<br />
'''Implications''' of using custom namespaces:<br />
* '''Search''': Pages in a custom namespace do not show up in default search results. So if we had a custom XCP namespace, it would mean that search results for XCP would not show up. One would need to go to '''Advanced Search''' and select XCP<br />
* '''Rename''': Renaming pages is possible and as straightforward as renaming pages<br />
* '''Xen Namespace''': The Xen namespace exists already, this may need to be renamed<br />
* '''Categories and Namespaces''': Categories cross namespaces. In other words, Category:XXX would go across all namespaces. As an example, see [[:Category:Wiki_Management]]<br />
<br />
<hr><br />
<br />
=== Mediwiki Issues ===<br />
<br />
==== [[Special:WantedPages]] broken ====<br />
===== '''Issue 1:''' Pages that need translation are spamming the list =====<br />
* Solution: fix language templates and mark with {{tl|Stub translation}}<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:48, 28 January 2013 (UTC):}} There is something wrong with the language templates, essentially spamming the wanted pages. Do ignore these instructions until fixed.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 23:28, 11 February 2013 (UTC):}} Fixed language template issues by removing most languages from the templates<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 18:03, 25 March 2013 (UTC):}} Started marking pages with {{tl|Stub translation}}<br />
<br />
===== '''Issue 2:''' Missing templates are spamming the list =====<br />
* Solution: mark missing templates with {{tl|Undefined Template}}<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 17:27, 25 March 2013 (UTC):}} Started marking all missing templates with {{tl|Undefined Template}}<br />
<br />
===== '''Issue 3:''' Missing categories are spamming the list ===== <br />
* Solution: mark with {{tl|Stub category}}<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 18:03, 25 March 2013 (UTC):}} Started marking pages with {{tl|Stub category}}<br />
<br />
==== Categories & Indexes ====<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:54, 29 January 2013 (UTC):}} Combined categories such as list all '''XCP FAQs''' have been asked for sevceral times<br />
* Investigate plug-ins<br />
<br />
<hr><br />
<br />
== Developer Docs ==<br />
<br />
=== Docs that need attention or are missing ===<br />
* Make XAPI docs (built from source) available on xen.org<br />
* PVOPS portal on xen.org - Konrad volunteered<br />
* some more xenstore docs (i.e. recent python bindings that were sent to the -users list<br />
* Using libxenstat python bindings (imo they're broken)<br />
* More PV protocol docs (see recent patches to blkif.h for example)<br />
* Document xenstore paths used by guests and toolstack etc<br />
** {{Comment|[[User:Ijc|Ijc]] 16:10, 26 November 2012 (UTC):}} This is now in tree: http://xenbits.xen.org/docs/unstable/misc/xenstore-paths.html<br />
<br />
== Done Recently ==<br />
<br />
==== Xen 4.3 new features that need documentation ====<br />
<br />
Need to make a HOWTO for openvswitch, link it to 4.3 test day and 4.3 release notes wiki pages.<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 16:04, 24 June 2013 (UTC)} These existed before. Linked to from [[Xen 4.3 Feature List]<br />
<br />
==== Xen 4.3 Man Pages ====<br />
Need to flesh out [[Xen_4.3_Man_Pages]] (also see [[Xen_4.2_Man_Pages]])<br />
<br />
==== Xen PV Architecture Documentation ====<br />
<br />
Something like a SDM for Xen PV "processors".<br />
<br />
Add pages to [[:Category:Paravirtualised Architecture]]<br />
<br />
* [[X86 Paravirtualised Memory Management]]<br />
** Needs OS specifics adding (e.g. Linux paravirt_ops)<br />
* Grant Tables<br />
* Event Channels<br />
* I/O (blk in OK shape, net could catch up)<br />
* ...<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:03, 29 January 2013 (UTC):}} [[Event Channel Internals]] was added<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:03, 29 January 2013 (UTC):}} Not sure how complete<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 10:58, 24 June 2013 (UTC)}} Enough of this has been done<br />
<br />
==== A Xen Performance Tuning Guide ====<br />
* Which workloads work for which virt mode. Network considerations. NUMA. VCPU Pinning. Etc.<br />
* Examples from the KVM world: [http://sheepdog.taobao.org/people/zituan/kvm_tuning.html Guest perf tuning], [http://www.linux-kvm.org/page/Tuning_KVM KVM options affecting performance], [http://publib.boulder.ibm.com/infocenter/lnxinfo/v3r0m0/index.jsp?topic=%2Fliaat%2Fliaattunkickoff.htm Comprehensive guide covering pinning, caching, memory, huge pages, etc.] <br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 19:50, 25 June 2012 (UTC):}} Work has been done on [[Tuning]]. Not sure whether more needs to be done.<br />
* {{Comment|[[User:StefanoStabellini|Stefano]] 30 June 2012:}} The guide is in a decent state but I will keep improving it during the next doc days.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 15:54, 19 September 2012 (UTC):}} Needs a quick sanity check for Xen 4.2<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done?<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 09:55, 24 June 2013 (UTC)}} Looks like it. But rename document<br />
<br />
==== Update Xen Release Features for Xen 4.3 ====<br />
Add Xen 4.3 to [[Xen_Release_Features]] and create [[Xen 4.3 Feature List]] (also see [[Xen 4.2 Feature List]])<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:36, 29 April 2013 (UTC):}} [[Xen_Release_Features]] has been done based on [[Xen_Roadmap/4.3]]<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:41, 29 April 2013 (UTC):}} Created boilerplate for [[Xen 4.3 Feature List]]<br />
<br />
<br />
==== Xen 4.3 Test Day Instructions ====<br />
Need to flesh out [[Xen_4.3_RC1_test_instructions]] (also see [[XCP_1.6_test_instructions]] and [[Xen 4.2 RC2 test instructions]])<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:36, 29 April 2013 (UTC):}} Has been done. ARM support needs adding. Also george had some ideas.<br />
<br />
==== A Xen Security Guide ====<br />
The different options in Xen for Security, trade-offs, how to set them up, how to test Xen for security and how to optimize for different scenarios<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 09:48, 27 March 2012 (UTC):}} [[:Category:Security]] contains some security related docs<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 11:01, 4 April 2012 (UTC):}} It would be good if we could document a) XSM, b) Introspection API, c) Xen and SELinux in Dom0, d) Memory Access API (introduced in 4.1)<br />
* User Docs that where migrating content would make sense and update such as (we can attach PDF's to the wiki now for starters, or we can use a [http://www.appropedia.org/Appropedia:Porting_PDF_files_to_MediaWiki conversion tool]<br />
** http://bits.xensource.com/Xen/docs/user.pdf<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 15:59, 19 September 2012 (UTC):}} Some good articles came out of XenSummit NA (these can be built upon). <br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:01, 29 January 2013 (UTC):}} Changes to [[Securing Xen]] & [[Driver Domain]]<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:01, 29 January 2013 (UTC):}} Got funding to document XSM; contract in place, but contractor is currently ill. This is the main outstanding issues.<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 07:57, 24 June 2013 (UTC)}} --[[User:Lars.kurth|Lars.kurth]] 07:57, 24 June 2013 (UTC)[[Xen_Security_Modules_:_XSM-FLASK]] has been added and I added an overview and removed the TODO<br />
<br />
==== Categories are not returned in search ====<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:54, 29 January 2013 (UTC):}} Categories do not get returned when searching. To find a category, once has to go to Advanced, click Categories and search for say ''security''.<br />
* We need to investigate whether there are better options for search (e.g. additional mediawiki plug-ins) or config options to change this behaviour<br />
* '''IMPORTANT:''' This is actually a user preference. To change the default behavior go to [[Special:Preferences]] and tick ''Main'', ''Xen'', ''Help'' and ''Category''. I will investigate defaults.<br />
* '''FIX:''' See [http://www.mediawiki.org/wiki/Manual:$wgNamespacesToBeSearchedDefault $wgNamespacesToBeSearchedDefault]<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:59, 3 May 2013 (UTC):}} Fixed<br />
<br />
==== Help create an htaccess file from xen_org to xenproject_org ====<br />
We need to create a mapping file from [http://xen.org/ xen_org] to [http://xenproject.org/ xenproject_org]. The plan is to archive [http://xen.org/ xen_org] to somewhere like http://xenproject.org/archive and to decide which pages in [http://xen.org/ xen_org] go to the archives, and which to the new site. I will track information at [[xen_org to xenproject_org mapping]].<br />
<br />
==== Submitting Xen Patches ====<br />
[[user:Dunlapg|George Dunlap]]: Updated [[Submitting Xen Patches]] to have recommended workflow for git; moved Mercurial-specifc instructions to [[Submitting Xen Patches - mercurial]] .<br />
<br />
==== Document release signing keys and fingerprints etc ====<br />
We should publish the key ids and fingerprints somewhere.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:54, 29 January 2013 (UTC):}} See [http://www.xen.org/projects/xenhv_keys.html OpenPGP keys]<br />
<br />
==== Better Statements on Compatibility ====<br />
There seems to be some confusion in the wider Linxu community about XL/XM compatibility. Maybe some specific questions in an FAQ/the release notes. Also migration compatibility comes up often. Any articles related to compatibility should be listed in [[:Category:Compatibility]], which I am willing to clean up.<br />
* {{Comment|[[User:Anthony|Anthony]] 14:33, 26 November 2012 (UTC):}} I add a bunch of pages to the category, and add few link in the category to upgrade from xend to xl.<br />
* {{Comment|[[User:Anthony|Anthony]] 17:19, 26 November 2012 (UTC):}} I also redirect [[XL in Xen 4.2]] to [[XL]] as they had both the same content minus few things.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done?<br />
* {{Comment|[[User:Ijc|Ijc]] 16:39, 25 January 2013 (UTC):}} I think we also need to cover compatibility confusion about 3.x vs 4.x.<br />
* {{Comment|[[User:Ijc|Ijc]] 15:03, 28 January 2013 (UTC):}} I've added [[Xen Version Compatibility]] and a link from [[Xen FAW Compatibility]]. I think this is probably done for now?<br />
<br />
==== Security related docs ====<br />
[[user:Dunlapg|George Dunlap]]: Revamped [[Driver_Domain]] and [[Securing_Xen]]<br />
<br />
==== cpupools intro / howto ====<br />
[[user:Dunlapg|George Dunlap]]: See [[Cpupools_Howto]]<br />
<br />
==== Clear up Xen TODO List ====<br />
* [[Setting_boot_order_for_domUs]]<br />
* [[XenDevelopmentProjects]] - although this will need maintaining<br />
* Revamp http://wiki.xen.org/wiki/Xen_PCI_Passthrough. Should be more organized, easier to follow, less verbose, more thorough, and more up-to-date.<br />
* Review and update http://en.wikipedia.org/wiki/Xen - in particular the "Host: Unix-like systems" is out-of-date. The Guest section is too.<br />
* Make [[:Category:Host_Install|Host Install]] and [[:Category:Guest_Install|Guest Install]] more useful <br />
** {{Comment|[[User:Lars.kurth|Lars.kurth]]:}} Note: both pages share [[Template:Distro_Resources]]<br />
** Docs for many distros are missing: identify what docs are missing or out of date and put them on the todo list<br />
* Feature Status Doc : [[Xen_Release_Features]]<br />
* [[Xen Overview]] which explains the top level architectural features and options, trade-offs and links to examples tutorials that show how you set these up<br />
* List i.e. stuff what to test after packaging. This would avoid the current state of affairs where most distros are infact broken w/re to Xen. See [[Distros]]<br />
* Installation Guides: How to install on various distros. Tag with [[:Category:Host Install]] and [[:Category:Guest_Install]].<br />
*[[Tuning]]<br />
* vcpu pinning (part of [[Tuning]])<br />
<br />
==== Document Policy on Maintenance Releases ====<br />
Which releases are supported, for how long. Owners. As well as a mechanism for individuals (or vendors) to take ownership of older releases (as is the case for Xen 3.4).<br />
* {{Comment|[[User:Ijc|Ijc]] 16:07, 26 November 2012 (UTC):}} Attempt to document current process: http://lists.xen.org/archives/html/xen-devel/2012-11/msg01389.html<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done, see [[Xen_Maintenance_Releases]]?<br />
* {{Comment|[[User:Ijc|Ijc]] 14:01, 22 January 2013 (UTC):}} Doc is complete and patches to reference it are in the various trees.<br />
<br />
==== Document {deb,rpm,tar}-pkg targets in kernel ====<br />
<br />
[[Mainline_Linux_Kernel_Configs]] talks about the obsolete and Debian specific <code>make-kpkg</code> tool. Should reference the kernels own <code>foo-pkg</code> targets instead.<br />
* {{Comment|[[User:Ijc|Ijc]] 12:12, 28 January 2013 (UTC):}} Done. Made a bunch of other cleanups too.<br />
<br />
[[Category:Community]]<br />
[[Category:Events]]</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=Xen_Document_Days/TODO&diff=9769Xen Document Days/TODO2013-09-30T14:53:18Z<p>Lisa.Nguyen: /* Manpages for xe command */</p>
<hr />
<div>{{WarningLeft|The Xen Wiki has been subject to a severe spam attack in the last few days. To solve this and keep the wiki usable for everyone, we had to lock down the wiki and create an editors group. Please [http://xenproject.org/component/content/article/100-misc/145-request-to-be-made-a-wiki-editor.html fill out this form] and we will add you to the group.}}<br />
----<br />
Go back to [[Xen Document Days]]<br />
<br />
== Requested Documentation ==<br />
<br />
{{InfoLeft|Feel free to comment on items using the following convention:<br />
<pre>* {{Comment|~~~~:}} your comment</pre><br />
Feel free to add new workitems using the following convention:<br />
<pre>==== Workitem ====<br />
~~~~: work-item description<br />
</pre>}}<br />
<br />
=== (IMPORTANT) XenAPI OpenStack Documentation ===<br />
See [https://blueprints.launchpad.net/openstack-manuals/+spec/redocument-xen related blueprint]<br />
<br />
=== (IMPORTANT) Linux Distros ===<br />
It seems that the list of Linux Distros which support Xen is a lot larger than listed on this wiki. <br />
* [http://www.funtoo.org/Xen Funtoo]<br />
* [https://wiki.mageia.org/en/XEN Mageia]<br />
* Are there others?<br />
The following pages need updating and new categories need to be created:<br />
* [[Dom0_Kernels_for_Xen]]<br />
* [[DomU_Support_for_Xen]]<br />
* [[Template:Distro_Resources]]<br />
* Add categories<br />
<br />
=== (IMPORTANT) Lose ends for transition from Mercurial to Git ===<br />
<br />
Pages that need fixing<br />
* [[XenParavirtOps]]<br />
* [[Xen_On_Funtoo_From_Scratch]]<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 13:46, 29 January 2013 (UTC):}}<br />
* [[Compiling Xen From Source]] {{Tick}}<br />
* [[Submitting Xen Patches]] {{Tick}}<br />
* [[Submitting_Xen_Patches_with_Git]] has been created<br />
* Marked pages with TODO's<br />
<br />
=== Restructure XCP Related Categories ===<br />
* This is executing the proposal http://lists.xenproject.org/archives/html/xen-api/2013-06/msg00109.html [Proposal for input] Disentangling XAPI, XAPI packages and XCP on wiki.xenproject.org]. In a nutshell:<br />
* Category XCP : only use for content specific to the XCP ISO<br />
* New Category XAPI Project : this is basically a category for developers<br />
* New Category XAPI Users : this is basically for users of XAPI, XAPI packages in distro and other flavours of XAPI (e.g. XCP ISO when not specific to the ISO)<br />
* Move content into those locations<br />
<br />
=== Xen 4.3 Documentation ===<br />
<br />
==== Xen 4.3 Release Notes ====<br />
Need to flesh out [[Xen_4.3_Release_Notes]] (also see [[Xen_4.2_Release_Notes]])<br />
<br />
==== Spice Config Example for upstream QEMU ====<br />
Take [http://lists.xenproject.org/archives/html/xen-users/2013-06/msg00423.html this thread] and convert into an Example<br />
<br />
=== In progress (some just need double checking whether finished) ===<br />
<br />
==== Better XCP Overview Documentation ====<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 08:02, 25 September 2012 (UTC):}} See [[XCP Overview]] & [[XCP Release Features]] - these need a little bit more work<br />
<br />
<br />
<hr><br />
<br />
=== Easy tasks for Beginners ===<br />
You may weant to read [[Help:Contents|Wiki Help]] if you do not have an account.<br />
<br />
==== Migrate useful blog posts to wiki ====<br />
Sift through blog.xen.org and copy useful posts to wiki. This will mainly be a reformatting exercise. Before you copy an article, perform a search on the wiki (headline or key word) to see whether the post exists already. If in doubt, ask on the IRC channel.<br />
<br />
==== Fix articles that need attention ====<br />
* [[:Category:Contains_Needs_Formatting]] - Pages that need formatting<br />
* [[:Category:Contains_Needs_Action]] - Pages that need fixing. Go through these, and if you get stuck ask people on the IRC channel for help, or go to the next page.<br />
* [[:Category:Contains_TODO]] - Pages that have a TODO item on the page. Go through these, and if you get stuck ask people on the IRC channel for help, or go to the next page.<br />
<br />
==== Review Categorization ====<br />
* Sometimes new pages on the wiki are not created with categories. You can find these by going to [[Special:UncategorizedPages]]. Documentation about which category is used where can be found in [[Categories for Authors]]. If in doubt ask on IRC.<br />
<br />
==== Pages With Comments or Improvement Suggestions ====<br />
* We ask users to highlight issues using '''talk pages''', following the conventions outlined in [[Help:Talk Pages]]. Comments made using these conventions can be identified using the [[:Category:Pages with comments]].<br />
<br />
==== Missing Pages ====<br />
* [[Special:WantedPages]] - You can find missing pages by going to this link. There are several courses of actoin that can be taken:<br />
** The page is needed : Add <code><nowiki>{{TODO|With a comment}}</nowiki></code> to the top of the page<br />
** The page is not needed : Remove the reference to the page (follow the link in the bracket besides the page)<br />
** Note that the list of Wanted pages contains lots of needed translations and categories, which you can ignore<br />
** If in doubt, ask for help on the IRC channel<br />
<br />
{{Comment|[[User:Double-p|Double-p]] 09:55, 25 February 2013 (UTC):}} There are a gazillion Template-Whatever including a TODO, really needed? <br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 17:40, 25 March 2013 (UTC):}} See [[#Special:WantedPages_broken]]<br />
<br />
<hr><br />
<br />
=== Xen : Open work items ===<br />
<br />
==== UEFI Secure Boot ====<br />
Write a document on how to sign the xen binary for UEFI Secure Boot. Potential reference here: [http://www.rodsbooks.com/efi-bootloaders/secureboot.html Dealing With Secure Boot]<br />
<br />
==== Manpages for xe command ====<br />
Write manpages for xe and its 430 subcommands. <br />
* A team led by [[user:GrantMcWilliams|Grant McWilliams]] and including [[user:Matthew.Spah|Matthew Spah]], [[user:Lisa.Nguyen|Lisa Nguyen]] and [[user:MRWebberOne|Mike Webber]] is currently working on documenting the xe command and will continue to do so until completed. Moving the source repo to xen-org has been [[http://lists.xen.org/archives/html/xen-api/2012-09/msg00053.html proposed]].<br />
* As of September 2013, the Xenapi Admin Project team is currently automating the manpage creation process for all xe subcommands.<br />
<br />
==== Describe the different ways, and necessary components, to create PVs using xl ====<br />
Raised by mail by ''Matthias Blankenhaus'' (who is prepared to take the lead, but needs help):<br />
This document would describe the different ways, and necessary components that each way requires, to create PVs using xl. Right now there are at least the following cases:<br />
* loopbacked vhds<br />
** single partition format<br />
** disk format<br />
* qemu backed vhds<br />
** qcow / qcow2<br />
* LVS backed image<br />
<br />
This is not a complete list. Also the mileage of each case differs depending on the kernel features enabled in dom0/domu and also depending on the Xen version. Furthermore, certain format require additional infrastructure like the tap device. <br />
<br />
All in all, this a complex topic that needs clarification. Doing this based on the lowest common denominator, xl, would clarify many things. In addition, baseline performance data on all of the above would help a great deal. Matthias volunteered to run the majority of needed perf tests<br />
<br />
==== Review and Update: xenpm usage recommendations ====<br />
There is [[Xen power management]] and [[Xenpm command]] which may all be outdated. These should probably be reviewed and updated.<br />
<br />
==== HOWTO : using xm trigger to poweroff or firing off NMIs ====<br />
Howto on using xm trigger to poweroff or firing off NMIs.<br />
<br />
==== HOWTO : How to Set Up Nested Virtualization ====<br />
See [http://lists.xen.org/archives/html/xen-users/2012-10/msg00311.html this thread]<br />
<br />
==== HOWTO: Chain pypxeboot and pygrub====<br />
How to chain [http://sourceforge.net/projects/pypxeboot/ pypxeboot] and pygrub <br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 10:35, 27 March 2012 (UTC):}} Is pypxeboot popular at all?<br />
* {{Comment|[[User:Fheigl|Fheigl]]:}} I added that. It is somewhat common, OVM 2 and OVM 3 rely on it for PXE installs. I'm not sure if xenpvnetboot is the same, or works. The use case is "you want to use the same installation server for Xen VMs and phys. servers. You want to be able to reinstall them based on PXE reply.<br />
* {{Comment|[[User:Fheigl|Fheigl]]:}} There is documentation for pypxeboot, but there is no (afaik) documentation for how pygrub is used as a fallback loader. We wasted many days just to get some hack that can't even load a newer kernel. Which sucks, in the end you spend more time/money making PV PXE boot work than you save by using virtualized servers.<br />
* {{Comment|[[User:Fheigl|Fheigl]]:}} How could it be popular given the state of documentation. <= Key issue to the left of this sentence.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:03, 19 September 2012 (UTC):}} wondering whether [https://vimeo.com/46125332 this video] contains what is needed<br />
<br />
<hr><br />
<br />
==== Openvswitch ====<br />
<br />
[[Network Configuration Examples (Xen 4.1+)]] for Openvswitch systems. How to configure guests. [[Xen_Networking]] updates. Perhaps a standalone page.<br />
<br />
=== XCP : Open work items ===<br />
<br />
==== XCP Beginners Guide ====<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 15:32, 28 January 2013 (UTC):}} We are missing the equivalent of the [[Xen Beginners Guide]] for XCP.<br />
* {{Comment|[[User:Double-p|Double-p]] 09:39, 25 March 2013 (UTC):}} see [[XCP Beginners Guide]] for review/additions<br />
<br />
==== Make titles of XCP and XAPI documentation consistent ====<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 13:09, 28 January 2013 (UTC):}} Often XCP related docs do not have XCP in the title, this makes it hard to find XCP related documents in titles. This is really hurting XCP users. Maybe this needs to be followed through in page categorisation also. Here is my proposal:<br />
* XCP related user documents should start with <code><nowiki>XCP:</nowiki></code><br />
* Design documents - these are design documents should probably be labelled <code><nowiki>Component-Name:</nowiki></code>, e.g. <code><nowiki>XAPI:</nowiki></code>, etc.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:36, 28 January 2013 (UTC):}} Would need to take [[#Visually_distinguish_Xen.2C_XCP_and_Community_Documentation_better|the next item]] into account. In other words using '''XCP:...''', '''XCP:XAPI:...''', etc. would make more sense and would allow implementing namespaces later.<br />
<br />
'''Also see:'''<br />
* [http://lists.xen.org/archives/html/xen-api/2013-01/msg00223.html Proposal on xen-api list]<br />
<br />
==== Visually distinguish Xen, XCP and Community Documentation better ====<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 15:32, 28 January 2013 (UTC):}} Users are getting confused when looking at wiki pages. If there was a visual way to distinguish Xen, XCP and Other content better, this would help. We could use colors and skinning when it comes to various elements, as well as masocts/logos:<br />
* For example: [[Help:Contents]] has a different feel (and colour scheme)<br />
* This could be replicated in trail boxes and other elements<br />
* We can also use mascots (note we don't have an XCP mascot)<br />
<br />
'''But first, I need to investigate what is possible.'''<br />
<br />
{{Comment|[[User:Lars.kurth|Lars.kurth]] 16:14, 28 January 2013 (UTC):}} Looks as if the only way this can be done is via [http://www.mediawiki.org/wiki/Manual:Using_custom_namespaces Custom Namespaces]. The only way to do this properly is to <br />
* Have different namespaces for Xen, XCP, ... and Community stuff and keep all the common stuff in Xen<br />
* The name spaces could then be styled differently, for example the '''Help''' namespace includes the '''ns-12''' style into the body attributes, whereas the '''Main (default)''' namespace uses the '''ns-14''' style. <br />
* Custom namespaces can be created by changing the config and are linked to custom styles<br />
* The styles are then defined in [[MediaWiki:Common.css]]<br />
<br />
'''Implications''' of using custom namespaces:<br />
* '''Search''': Pages in a custom namespace do not show up in default search results. So if we had a custom XCP namespace, it would mean that search results for XCP would not show up. One would need to go to '''Advanced Search''' and select XCP<br />
* '''Rename''': Renaming pages is possible and as straightforward as renaming pages<br />
* '''Xen Namespace''': The Xen namespace exists already, this may need to be renamed<br />
* '''Categories and Namespaces''': Categories cross namespaces. In other words, Category:XXX would go across all namespaces. As an example, see [[:Category:Wiki_Management]]<br />
<br />
<hr><br />
<br />
=== Mediwiki Issues ===<br />
<br />
==== [[Special:WantedPages]] broken ====<br />
===== '''Issue 1:''' Pages that need translation are spamming the list =====<br />
* Solution: fix language templates and mark with {{tl|Stub translation}}<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:48, 28 January 2013 (UTC):}} There is something wrong with the language templates, essentially spamming the wanted pages. Do ignore these instructions until fixed.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 23:28, 11 February 2013 (UTC):}} Fixed language template issues by removing most languages from the templates<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 18:03, 25 March 2013 (UTC):}} Started marking pages with {{tl|Stub translation}}<br />
<br />
===== '''Issue 2:''' Missing templates are spamming the list =====<br />
* Solution: mark missing templates with {{tl|Undefined Template}}<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 17:27, 25 March 2013 (UTC):}} Started marking all missing templates with {{tl|Undefined Template}}<br />
<br />
===== '''Issue 3:''' Missing categories are spamming the list ===== <br />
* Solution: mark with {{tl|Stub category}}<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 18:03, 25 March 2013 (UTC):}} Started marking pages with {{tl|Stub category}}<br />
<br />
==== Categories & Indexes ====<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:54, 29 January 2013 (UTC):}} Combined categories such as list all '''XCP FAQs''' have been asked for sevceral times<br />
* Investigate plug-ins<br />
<br />
<hr><br />
<br />
== Developer Docs ==<br />
<br />
=== Docs that need attention or are missing ===<br />
* Make XAPI docs (built from source) available on xen.org<br />
* PVOPS portal on xen.org - Konrad volunteered<br />
* some more xenstore docs (i.e. recent python bindings that were sent to the -users list<br />
* Using libxenstat python bindings (imo they're broken)<br />
* More PV protocol docs (see recent patches to blkif.h for example)<br />
* Document xenstore paths used by guests and toolstack etc<br />
** {{Comment|[[User:Ijc|Ijc]] 16:10, 26 November 2012 (UTC):}} This is now in tree: http://xenbits.xen.org/docs/unstable/misc/xenstore-paths.html<br />
<br />
== Done Recently ==<br />
<br />
==== Xen 4.3 new features that need documentation ====<br />
<br />
Need to make a HOWTO for openvswitch, link it to 4.3 test day and 4.3 release notes wiki pages.<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 16:04, 24 June 2013 (UTC)} These existed before. Linked to from [[Xen 4.3 Feature List]<br />
<br />
==== Xen 4.3 Man Pages ====<br />
Need to flesh out [[Xen_4.3_Man_Pages]] (also see [[Xen_4.2_Man_Pages]])<br />
<br />
==== Xen PV Architecture Documentation ====<br />
<br />
Something like a SDM for Xen PV "processors".<br />
<br />
Add pages to [[:Category:Paravirtualised Architecture]]<br />
<br />
* [[X86 Paravirtualised Memory Management]]<br />
** Needs OS specifics adding (e.g. Linux paravirt_ops)<br />
* Grant Tables<br />
* Event Channels<br />
* I/O (blk in OK shape, net could catch up)<br />
* ...<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:03, 29 January 2013 (UTC):}} [[Event Channel Internals]] was added<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:03, 29 January 2013 (UTC):}} Not sure how complete<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 10:58, 24 June 2013 (UTC)}} Enough of this has been done<br />
<br />
==== A Xen Performance Tuning Guide ====<br />
* Which workloads work for which virt mode. Network considerations. NUMA. VCPU Pinning. Etc.<br />
* Examples from the KVM world: [http://sheepdog.taobao.org/people/zituan/kvm_tuning.html Guest perf tuning], [http://www.linux-kvm.org/page/Tuning_KVM KVM options affecting performance], [http://publib.boulder.ibm.com/infocenter/lnxinfo/v3r0m0/index.jsp?topic=%2Fliaat%2Fliaattunkickoff.htm Comprehensive guide covering pinning, caching, memory, huge pages, etc.] <br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 19:50, 25 June 2012 (UTC):}} Work has been done on [[Tuning]]. Not sure whether more needs to be done.<br />
* {{Comment|[[User:StefanoStabellini|Stefano]] 30 June 2012:}} The guide is in a decent state but I will keep improving it during the next doc days.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 15:54, 19 September 2012 (UTC):}} Needs a quick sanity check for Xen 4.2<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done?<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 09:55, 24 June 2013 (UTC)}} Looks like it. But rename document<br />
<br />
==== Update Xen Release Features for Xen 4.3 ====<br />
Add Xen 4.3 to [[Xen_Release_Features]] and create [[Xen 4.3 Feature List]] (also see [[Xen 4.2 Feature List]])<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:36, 29 April 2013 (UTC):}} [[Xen_Release_Features]] has been done based on [[Xen_Roadmap/4.3]]<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:41, 29 April 2013 (UTC):}} Created boilerplate for [[Xen 4.3 Feature List]]<br />
<br />
<br />
==== Xen 4.3 Test Day Instructions ====<br />
Need to flesh out [[Xen_4.3_RC1_test_instructions]] (also see [[XCP_1.6_test_instructions]] and [[Xen 4.2 RC2 test instructions]])<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:36, 29 April 2013 (UTC):}} Has been done. ARM support needs adding. Also george had some ideas.<br />
<br />
==== A Xen Security Guide ====<br />
The different options in Xen for Security, trade-offs, how to set them up, how to test Xen for security and how to optimize for different scenarios<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 09:48, 27 March 2012 (UTC):}} [[:Category:Security]] contains some security related docs<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 11:01, 4 April 2012 (UTC):}} It would be good if we could document a) XSM, b) Introspection API, c) Xen and SELinux in Dom0, d) Memory Access API (introduced in 4.1)<br />
* User Docs that where migrating content would make sense and update such as (we can attach PDF's to the wiki now for starters, or we can use a [http://www.appropedia.org/Appropedia:Porting_PDF_files_to_MediaWiki conversion tool]<br />
** http://bits.xensource.com/Xen/docs/user.pdf<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 15:59, 19 September 2012 (UTC):}} Some good articles came out of XenSummit NA (these can be built upon). <br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:01, 29 January 2013 (UTC):}} Changes to [[Securing Xen]] & [[Driver Domain]]<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 14:01, 29 January 2013 (UTC):}} Got funding to document XSM; contract in place, but contractor is currently ill. This is the main outstanding issues.<br />
* {{Comment|--[[User:Lars.kurth|Lars.kurth]] 07:57, 24 June 2013 (UTC)}} --[[User:Lars.kurth|Lars.kurth]] 07:57, 24 June 2013 (UTC)[[Xen_Security_Modules_:_XSM-FLASK]] has been added and I added an overview and removed the TODO<br />
<br />
==== Categories are not returned in search ====<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:54, 29 January 2013 (UTC):}} Categories do not get returned when searching. To find a category, once has to go to Advanced, click Categories and search for say ''security''.<br />
* We need to investigate whether there are better options for search (e.g. additional mediawiki plug-ins) or config options to change this behaviour<br />
* '''IMPORTANT:''' This is actually a user preference. To change the default behavior go to [[Special:Preferences]] and tick ''Main'', ''Xen'', ''Help'' and ''Category''. I will investigate defaults.<br />
* '''FIX:''' See [http://www.mediawiki.org/wiki/Manual:$wgNamespacesToBeSearchedDefault $wgNamespacesToBeSearchedDefault]<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:59, 3 May 2013 (UTC):}} Fixed<br />
<br />
==== Help create an htaccess file from xen_org to xenproject_org ====<br />
We need to create a mapping file from [http://xen.org/ xen_org] to [http://xenproject.org/ xenproject_org]. The plan is to archive [http://xen.org/ xen_org] to somewhere like http://xenproject.org/archive and to decide which pages in [http://xen.org/ xen_org] go to the archives, and which to the new site. I will track information at [[xen_org to xenproject_org mapping]].<br />
<br />
==== Submitting Xen Patches ====<br />
[[user:Dunlapg|George Dunlap]]: Updated [[Submitting Xen Patches]] to have recommended workflow for git; moved Mercurial-specifc instructions to [[Submitting Xen Patches - mercurial]] .<br />
<br />
==== Document release signing keys and fingerprints etc ====<br />
We should publish the key ids and fingerprints somewhere.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 13:54, 29 January 2013 (UTC):}} See [http://www.xen.org/projects/xenhv_keys.html OpenPGP keys]<br />
<br />
==== Better Statements on Compatibility ====<br />
There seems to be some confusion in the wider Linxu community about XL/XM compatibility. Maybe some specific questions in an FAQ/the release notes. Also migration compatibility comes up often. Any articles related to compatibility should be listed in [[:Category:Compatibility]], which I am willing to clean up.<br />
* {{Comment|[[User:Anthony|Anthony]] 14:33, 26 November 2012 (UTC):}} I add a bunch of pages to the category, and add few link in the category to upgrade from xend to xl.<br />
* {{Comment|[[User:Anthony|Anthony]] 17:19, 26 November 2012 (UTC):}} I also redirect [[XL in Xen 4.2]] to [[XL]] as they had both the same content minus few things.<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done?<br />
* {{Comment|[[User:Ijc|Ijc]] 16:39, 25 January 2013 (UTC):}} I think we also need to cover compatibility confusion about 3.x vs 4.x.<br />
* {{Comment|[[User:Ijc|Ijc]] 15:03, 28 January 2013 (UTC):}} I've added [[Xen Version Compatibility]] and a link from [[Xen FAW Compatibility]]. I think this is probably done for now?<br />
<br />
==== Security related docs ====<br />
[[user:Dunlapg|George Dunlap]]: Revamped [[Driver_Domain]] and [[Securing_Xen]]<br />
<br />
==== cpupools intro / howto ====<br />
[[user:Dunlapg|George Dunlap]]: See [[Cpupools_Howto]]<br />
<br />
==== Clear up Xen TODO List ====<br />
* [[Setting_boot_order_for_domUs]]<br />
* [[XenDevelopmentProjects]] - although this will need maintaining<br />
* Revamp http://wiki.xen.org/wiki/Xen_PCI_Passthrough. Should be more organized, easier to follow, less verbose, more thorough, and more up-to-date.<br />
* Review and update http://en.wikipedia.org/wiki/Xen - in particular the "Host: Unix-like systems" is out-of-date. The Guest section is too.<br />
* Make [[:Category:Host_Install|Host Install]] and [[:Category:Guest_Install|Guest Install]] more useful <br />
** {{Comment|[[User:Lars.kurth|Lars.kurth]]:}} Note: both pages share [[Template:Distro_Resources]]<br />
** Docs for many distros are missing: identify what docs are missing or out of date and put them on the todo list<br />
* Feature Status Doc : [[Xen_Release_Features]]<br />
* [[Xen Overview]] which explains the top level architectural features and options, trade-offs and links to examples tutorials that show how you set these up<br />
* List i.e. stuff what to test after packaging. This would avoid the current state of affairs where most distros are infact broken w/re to Xen. See [[Distros]]<br />
* Installation Guides: How to install on various distros. Tag with [[:Category:Host Install]] and [[:Category:Guest_Install]].<br />
*[[Tuning]]<br />
* vcpu pinning (part of [[Tuning]])<br />
<br />
==== Document Policy on Maintenance Releases ====<br />
Which releases are supported, for how long. Owners. As well as a mechanism for individuals (or vendors) to take ownership of older releases (as is the case for Xen 3.4).<br />
* {{Comment|[[User:Ijc|Ijc]] 16:07, 26 November 2012 (UTC):}} Attempt to document current process: http://lists.xen.org/archives/html/xen-devel/2012-11/msg01389.html<br />
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done, see [[Xen_Maintenance_Releases]]?<br />
* {{Comment|[[User:Ijc|Ijc]] 14:01, 22 January 2013 (UTC):}} Doc is complete and patches to reference it are in the various trees.<br />
<br />
==== Document {deb,rpm,tar}-pkg targets in kernel ====<br />
<br />
[[Mainline_Linux_Kernel_Configs]] talks about the obsolete and Debian specific <code>make-kpkg</code> tool. Should reference the kernels own <code>foo-pkg</code> targets instead.<br />
* {{Comment|[[User:Ijc|Ijc]] 12:12, 28 January 2013 (UTC):}} Done. Made a bunch of other cleanups too.<br />
<br />
[[Category:Community]]<br />
[[Category:Events]]</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=User:Lisa.Nguyen&diff=6703User:Lisa.Nguyen2013-03-06T22:23:44Z<p>Lisa.Nguyen: /* Contact */</p>
<hr />
<div>Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams].<br />
<br />
== Contact ==<br />
Email: lisa@xenapiadmin.com<br />
<br />
Google+: http://gplus.to/lisatn<br />
<br />
LinkedIn Profile: http://www.linkedin.com/in/lisatn<br />
<br />
Project website: http://xenapiadmin.com</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=User:Lisa.Nguyen&diff=6702User:Lisa.Nguyen2013-03-06T22:21:20Z<p>Lisa.Nguyen: /* Contact */</p>
<hr />
<div>Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams].<br />
<br />
== Contact ==<br />
Email: ltn821@hotmail.com<br />
<br />
Google+: http://gplus.to/lisatn<br />
<br />
LinkedIn Profile: http://www.linkedin.com/in/lisatn<br />
<br />
Project website: http://xenapiadmin.com</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=User:Lisa.Nguyen&diff=5180User:Lisa.Nguyen2012-09-24T23:42:37Z<p>Lisa.Nguyen: /* Contact */</p>
<hr />
<div>Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams].<br />
<br />
== Contact ==<br />
Email: ltn821@hotmail.com<br />
<br />
Google+: http://gplus.to/lisatn<br />
<br />
LinkedIn Profile: http://www.linkedin.com/in/lisatn</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=User:Lisa.Nguyen&diff=5178User:Lisa.Nguyen2012-09-24T23:37:23Z<p>Lisa.Nguyen: </p>
<hr />
<div>Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams].<br />
<br />
== Contact ==<br />
<br />
Google+: http://gplus.to/lisatn<br />
<br />
LinkedIn Profile: http://www.linkedin.com/in/lisatn</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=User:Lisa.Nguyen&diff=5177User:Lisa.Nguyen2012-09-24T23:36:43Z<p>Lisa.Nguyen: </p>
<hr />
<div>Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams].<br />
<br />
<br />
== Contact ==<br />
<br />
Google+: http://gplus.to/lisatn<br />
<br />
LinkedIn Profile: http://www.linkedin.com/in/lisatn</div>Lisa.Nguyenhttps://wiki.xenproject.org/index.php?title=User:Lisa.Nguyen&diff=5172User:Lisa.Nguyen2012-09-24T23:25:00Z<p>Lisa.Nguyen: Created page with "Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams]."</p>
<hr />
<div>Active project manager for the Xen Cloud Platform documentation team led by [http://wiki.xen.org/wiki/User:GrantMcWilliams Grant McWilliams].</div>Lisa.Nguyen