elementary-dev-community team mailing list archive
Mailing list archive
Re: The elementary documentation weekend!
Is there a doc about how to go about documenting code?
That will help us a lot.
On Nov 5, 2013 3:32 PM, "David Gomes" <david@xxxxxxxxxxxxxxxx> wrote:
> Completely agreed Daniel, I guess teemperor listed my doc more as a doc
> example rather than what we're gonna do.
> However, thank you for reminding everyone of that.
> Still, I'll be focusing on development documentation and other technical
> stuff, but I'm still not sure.
> On Nov 5, 2013 2:16 AM, "Daniel Foré" <daniel@xxxxxxxxxxxxxxxx> wrote:
>> I want to take the opportunity to remind everyone that we DO NOT need an
>> extended customization guide. There are plenty of great articles and
>> websites that cover these topics extensively.
>> When we're talking about user documentation, we want to show users how to
>> do things. Most of the time this is stuff that is obvious to me and you
>> like how to crop a photo or how to create an archive and email it to
>> Sent from Mailbox <https://www.dropbox.com/mailbox> for iPhone
>> On Mon, Nov 4, 2013 at 10:49 AM, Raphael Isemann <teemperor@xxxxxxxxx>wrote:
>>> 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. 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 .
>>> *I have a new idea*
>>> If you found something else that you would like to have some
>>> documentation about, just add it to  (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 
>>> 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  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
>>> Mailing list: https://launchpad.net/~elementary-dev-community
>>> Post to : elementary-dev-community@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~elementary-dev-community
>>> More help : https://help.launchpad.net/ListHelp
>> Mailing list: https://launchpad.net/~elementary-dev-community
>> Post to : elementary-dev-community@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~elementary-dev-community
>> More help : https://help.launchpad.net/ListHelp
> Mailing list: https://launchpad.net/~elementary-dev-community
> Post to : elementary-dev-community@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~elementary-dev-community
> More help : https://help.launchpad.net/ListHelp