Xen Project Document Days: Difference between revisions

From Xen
Jump to navigationJump to search
m (Banner for July 29th docsday)
No edit summary
 
(149 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!--{{InfoLeft|TODAY, Wednesday December 2, is [[Xen Project Document Days|Document Day]]!}}-->
----
__NOTOC__
__NOTOC__
⚫
{{WarningLeft|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 [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.}}
{{InfoLeft|The next [[Xen Document Days]] for is on July 29th 2013}}
⚫
{{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.}}
----
----
{{Trailbox|Information about Document Days|TODO
{{Trailbox|Information about Document Days|TODO
|{{Trail|Next dates|
|{{Trail|Next dates|
* TBD, January 2016
⚫
* July 29, 2013
⚫
* August 26, 2013
⚫
* September 30, 2013
}}
}}
|{{Trail|More Information|
|{{Trail|More Information|
Line 21: Line 20:
}}
}}


== What is a Xen Document Day? ==
== What is a Xen Project Document Day? ==
Xen document days are all day IRC events, facilitated by members of the Xen community. The purpose of Xen Document Days is to
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 user documentation
* Improve developer documentation, including the creation of man pages, etc.
* Improve developer documentation, including the creation of man pages, etc.
Line 28: Line 27:


{{Anchor|HOW}}
{{Anchor|HOW}}

== How Does it Work? ==
== How Does it Work? ==
* Request to be a [http://xenproject.org/component/content/article/100-misc/145-request-to-be-made-a-wiki-editor.html Wiki editor]
* Join us on IRC: freenode channel #xendocs
* 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)
* Tell people what you intend to work on (to avoid doing something somebody else is already working on)
Line 34: Line 35:
* Help others
* Help others
* And above all: have fun!
* And above all: have fun!

{{Anchor|THEME}}
== THEME OF THE MONTH: "Beginner Information" ==

We've seen an increase of interest from potential new users recently and we need to make sure that people can successfully get started with 4.6 using our current set of Wiki pages. We have been slowly replacing the '''xm''' references with '''xl''', but we could use people to read over many of the existing pages to make sure they still make sense with the latest release.

Pages of special interest include:

* [[Xen Project Beginners Guide]] (recently revised, but could use a read-through)
* [[Getting Started]]
* [[Xen Project Best Practices]]
* [[Xen Common Problems]]

And, of course, any other page which needs to reflect the realities of working with 4.6.


== Other ways to Help ==
== 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 [http://www.mediawiki.org/wiki/Help:Navigation#Page_tabs “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]].
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 [http://www.mediawiki.org/wiki/Help:Navigation#Page_tabs “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]].
<!--

= Stats =
= Stats =
* [[Xen_Document_Days/Acknowledgements/Jan2013]]: We changed >11K words on the wiki in more than 126 changesets. Changes to xen.org static pages were made. More than 25 people participated on IRC, and we had vibrant discussions on how to change navigation and other items, which led to new sections in the TODO list, e.g. [[Xen_Document_Days/TODO#Mediwiki_Issues|Mediwiki Issues]] and [[Xen_Document_Days/TODO#XCP_:_Open_work_items|XCP : Open work items]]
* [[Xen_Document_Days/Acknowledgements/Jan2013]]: We changed >11K words on the wiki in more than 126 changesets. Changes to xen.org static pages were made. More than 25 people participated on IRC, and we had vibrant discussions on how to change navigation and other items, which led to new sections in the TODO list, e.g. [[Xen_Document_Days/TODO#Mediwiki_Issues|Mediwiki Issues]] and [[Xen_Document_Days/TODO#XCP_:_Open_work_items|XCP : Open work items]]
Line 45: Line 60:
Lessons learned:
Lessons learned:
* More up-front coordination on the mailing list a week before the document day helps
* More up-front coordination on the mailing list a week before the document day helps
-->

⚫
== 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)
<!--
== Initial proposed dates for 2014 ==
⚫
In 2013, we agreed on the mailing list that Xen Project Document days will be held the '''last Monday of each month'''. If the date clashes with say a major Xen Project event or a holiday, we will try and find an alternative date.

Following this rule, the initial 2014 dates were:
* January 27, 2014
* February 24, 2014
* March 31, 2014


In March 2014, it became clear that Mondays are problematic to many. Multiple countries have Monday holidays, a number of people's schedules are difficult on Mondays, etc. So, in April, we tried the last Wednesday of the month.
⚫
== Proposed dates for 2013 ==
⚫
We agreed on the mailing list that Xen Document days will be held the '''last Monday of each month''', starting from Feb. If the date clashes with say a major Xen event or a holiday, we will try and find an alternative date.


As the Wednesday test was successful in April, we are now proposing dates of:
This means the 2013 dates are:
* April 29, 2013
* April 30, 2014
* May 28, 2013
* May 28, 2014
* June 24, 2013
* June 25, 2014
* July 29, 2013
* July 30, 2014
* August 26, 2013
* August 27, 2014
* September 30, 2013
* September 24, 2014
* October 29, 2014 (moved to November 5 due to Test Day on October 29)
⚫
* October 28, 2013
* December 10, 2014 (due to holiday schedules in November and December, then moved to December 15 due to Test Day scheduling)
* November 25, 2013
-->
* December 16, 2013 (earlier due to XMas)


== Extra Days ==
== Extra Days ==
Some community members indicated that they would like an extra doc day on a public holiday or weekend. I am 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.
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.


[[Category:Community]]
[[Category:Community]]

Latest revision as of 03:28, 3 December 2015

Icon Ambox.png 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.

Information about Document Days
Next dates
  • TBD, January 2016
More Information
IRC
  • Freenode channel #xendocs
  • Turn up
  • Work on documentation
  • Have fun!

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: "Beginner Information"

We've seen an increase of interest from potential new users recently and we need to make sure that people can successfully get started with 4.6 using our current set of Wiki pages. We have been slowly replacing the xm references with xl, but we could use people to read over many of the existing pages to make sure they still make sense with the latest release.

Pages of special interest include:

And, of course, any other page which needs to reflect the realities of working with 4.6.

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)

Extra Days

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.

Retrieved from "https://wiki.xenproject.org/index.php?title=Xen_Project_Document_Days&oldid=15955"