Improving Our Docs

[Jono Bacon]

On Thu, Jun 20, 2013 at 7:08 PM, Daniel van Vugt <
daniel.van.vugt at canonical.com> wrote:

> Just some notes to consider before anyone tries to write docs:
>
>
> * How to write a a Mir backend for a window manager / toolkit. This could
> really help other projects that are interested in supporting Mir.
>  - Backend for a "window manager": This means a shell, linking to
> libmirserver. I may be alone in thinking this, but am not comfortable we
> have our class structure (via libmirserver) quite right to go documenting
> this yet. But still, you can look at examples/demo-shell/*
> which some might find surprising to hear is intended to be a totally
> generic shell with no links to Unity. It still needs more functionality
> yet, though.
>

Makes sense, but in the interim, having this information and pointing to
examples/demo-shell would likely help. Any idea when we the class structure
may be more stabilized?


>  - Toolkit: This means a client linking to libmirclient. The client API is
> *almost* completely stable now. Changes are minimal these days so it's safe
> to document, and the basics are documented:
>    http://unity.ubuntu.com/mir/**group__mir__toolkit.html<http://unity.ubuntu.com/mir/group__mir__toolkit.html>
>
>
So this looks API documentation, which is useful, but I was thinking it
would be more useful to have a short tutorial or walkthrough the steps of
how to create a client. Is this something someone would be willing to
volunteer to write and link on the Mir wikisite?

>
> * How to build Mir for non-Ubuntu systems. Jef Spaleta shared this concern
> with me this week, and I think some more generic build instructions would
> be useful.
>  - I totally agree we need to make building everything-Mir easier, for
> everyone. We have had discussions and will work on easing the process. I
> think it could be documented now but that documentation will of course
> evolve with the projects themselves.
>
>
Makes sense. Maybe this documentation will be better served as a wiki page.

Jef, if the team would be happy to work on this, would you be happy to help
document building Mir for Fedora?

>
> * How to write a driver that supports Mir. This could be of interest for a
> hardware company who is interested in exploring Mir support for their
> hardware.
>   - This can not be documented until we have at least had a first attempt
> at making it possible to load external code:
>     https://bugs.launchpad.net/**mir/+bug/1118909<https://bugs.launchpad.net/mir/+bug/1118909>
>
>
When Alan fixes this bug and we are in a position to do this, would be
happy to have a crack at writing something here?

Thanks, Daniel!

   Jono


> - Daniel
>
>
>
> On 21/06/13 06:55, Jono Bacon wrote:
>
>> Hi,
>>
>> Some time ago I asked Daniel Holbach to coordinate with the Mir team to
>> improve the documentation on wiki.ubuntu.com/Mir
>> <http://wiki.ubuntu.com/Mir> to make it simple to participate in Mir
>>
>> development. I think Daniel and the team did a great job there.
>>
>> There are now some other documentation needs that I think we need in
>> light of recent discussions:
>>
>>   * How to write a a Mir backend for a window manager / toolkit. This
>> could really help other projects that are interested in supporting Mir.
>>
>>   * How to build Mir for non-Ubuntu systems. Jef Spaleta shared this
>> concern with me this week, and I think some more generic build
>> instructions would be useful.
>>
>>   * How to write a driver that supports Mir. This could be of interest
>> for a hardware company who is interested in exploring Mir support for
>> their hardware.
>>
>> I have Daniel to take care of working with our community and Mir
>> engineers to put together these docs. Is anyone willing to help
>> contribute to putting this content together as part of this effort?
>>
>> Thanks!
>>
>>     Jono
>>
>> --
>> Jono Bacon
>> Ubuntu Community Manager
>> www.ubuntu.com <http://www.ubuntu.com> / www.jonobacon.org
>> <http://www.jonobacon.org>
>> www.identi.ca/jonobacon <http://www.identi.ca/**jonobacon<http://www.identi.ca/jonobacon>
>> >
>> www.twitter.com/jonobacon <http://www.twitter.com/**jonobacon<http://www.twitter.com/jonobacon>
>> >
>>
>>
>>
> --
> Mir-devel mailing list
> Mir-devel at lists.ubuntu.com
> Modify settings or unsubscribe at: https://lists.ubuntu.com/**
> mailman/listinfo/mir-devel<https://lists.ubuntu.com/mailman/listinfo/mir-devel>
>



-- 
Jono Bacon
Ubuntu Community Manager
www.ubuntu.com / www.jonobacon.org
www.identi.ca/jonobacon www.twitter.com/jonobacon
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/mir-devel/attachments/20130620/58428470/attachment-0001.html>