← Back to team overview

elementary-dev-community team mailing list archive

Re: The elementary documentation weekend!


I actually started to rewrite the HIG earlier in the year that Dan seemed
to like but unfortunately I never heard back from Cassidy about it so I
didn't get much farther (didn't want to do a whole bunch of work only to
find out it sucked from the beginning). I was more focused on just cleaning
it up first, but I was thinking after we get it more professional looking
it might be a good idea to think of alternative ways of organizing the
concepts so the HIG doesn't seem so GNOMEy.

If you want to see my rough draft, I pasted it here: http://sprunge.us/MjUE


On Mon, Nov 4, 2013 at 1:48 PM, 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[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?*
> Everyone!
> *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
> document).
> *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:
> http://creativecommons.org/licenses/by/2.0/
> 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
> http://creativecommons.org/licenses/by/2.0/
> """
> 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
> --
> 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

Follow ups