← Back to team overview

elementary-dev-community team mailing list archive

The elementary documentation weekend!


Ladies and Gentlemen,

If you haven't heard already, we are doing a documentation
weekend/sprint from November 8th to November 10th.

*What is the sprint/weekend about?*
Write documentation about anything that is related to elementary! Here
is an example of what we mean[1]. We need both development
documentation as well as user-oriented stuff.

In fact, we hope that we can integrate a lot of the written stuff into
the User Guide/Developer Section.

*Who can attend?*

*Need ideas?*
See [2].

*I have a new idea*
If you found something else that you would like to have some
documentation about, just add it to [2] (anyone can edit this

*Do I need to use any special software?*
You can use whatever you want. I recommend Google Docs and similar
services but you can also just use a text editor and www.pastebin.com.
Either way, just make sure that you add yourself to the document [2]
or mail your entry to this thread in the mailing list.

*Under what license am I supposed to release my documentation?*
CC-BY, read this for more information:
To license your work you need to add this note to the end of the
document (see [1] for an example):

This work is licensed under a CC-BY-license, for more information see

It's important that you apply this license to your document so that we
can integrate it into the User Guide, so please don't forget about it.

*Any questions left?*
You can reply to this email or you use IRC via our webchat (
http://elementaryos.org/developer/chat ). You're obviously free to
fire up your IRC client and connect to: irc.freenode.net and join
#elementary-dev. We will probably not answer instantly, so be patient.
Alternatively, you can ping me personally using my nickname teemperor
(Munchor also enjoys being pinged all day long).

-- Raphael "Teemperor" Isemann

[1] https://docs.google.com/document/d/1W61JhA5GR6GH0iSc2brAVjCF_Xh-gpN6blqCkv3vaCo/edit
[2] https://docs.google.com/document/d/1wFTYGaP9RR5JwT4qQfix84-TfeFaDNX9iFviVtuCAi4/edit

Follow ups