Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-09 Thread Allan Day
Shaun McCance wrote: ... > It is worth looking into sharing solutions with other projects. But most > projects seem to do what we've done: home-brew a solution that fits > exactly their needs. Hard to share that. In that case, I've got some mockups in the works for a new site: https://github.com

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-06 Thread Frederic Peters
I wrote: > There are a few outstanding bugs (old development versions are pruned > from the index files but not from the server, and are getting indexed by > Google), [...] That particular bug has now been fixed, old development versions are now properly removed from the server; however I don't k

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Shaun McCance
On Fri, 2014-09-05 at 18:52 +0100, Allan Day wrote: > Shaun McCance wrote: > ... > > RTD has been hugely popular in the Python world, but it's not the only > > continuous deployment or automated docs build system out there. Red Hat > > and Fedora use Publican for almost everything. ... > > The Re

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Allan Day
Shaun McCance wrote: ... > RTD has been hugely popular in the Python world, but it's not the only > continuous deployment or automated docs build system out there. Red Hat > and Fedora use Publican for almost everything. ... The Red Hat Publican deployment seems fairly custom - it is pretty nice,

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Allan Day
> Frederic Peters wrote: >> ... I'd prefer to have ideas on the structure we >> want before we go looking for the appropriate software (or changes to >> the library-web code base). ... Thinking about this, if we are going to do something homebrew, then I can I can come up with more detailed plans

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Allan Day
Frederic Peters wrote: ... >> RTD has been hugely popular in the Python world, but it's not the only >> continuous deployment or automated docs build system out there. Red Hat >> and Fedora use Publican for almost everything. OpenStack has a big pile >> of Maven code that builds its site. There ar

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Frederic Peters
Hi Shaun, > How much maintenance burden is there for the general infrastructure of > library-web, versus the burden of the various converters and such that > we'd have to deal with anyway if plugging them into another system? There's not much maintenance required, for example new modules are auto

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Shaun McCance
On Fri, 2014-09-05 at 11:24 +0200, Frederic Peters wrote: > Allan Day wrote: > > > One of the reasons why I wanted to have this conversation is to find > > out if there are any third party solutions that we could use, rather > > than having to write and maintain our own site from scratch? Is Read

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Frederic Peters
Allan Day wrote: > One of the reasons why I wanted to have this conversation is to find > out if there are any third party solutions that we could use, rather > than having to write and maintain our own site from scratch? Is Read > the Docs [1] an option? It's a first look from that perspective,

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Allan Day
Frederic Peters wrote: ... > I would tend to put goals before technical details, but library-web as > it is nowadays is certainly not the best option; I addressed a few of > the issues in my mail to gnome-doc-devel-list@. ... >> * Hackability ... >> * User experience ... >> * Documentation w

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-05 Thread Allan Day
Jasper St. Pierre wrote: > While I'm sure a dynamic site would be a great idea in the far future, are > there any small, actionable goals we can make for this? As Fred already said, this list is probably the critical priority - https://wiki.gnome.org/DocumentationProject/Tasks/DeveloperDocs#deve

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-04 Thread Frederic Peters
Jasper St. Pierre wrote: > While I'm sure a dynamic site would be a great idea in the far future, are > there any small, actionable goals we can make for this? > > We all dream of a great docs scenario, but we never properly plan for it. > What small wins can we get today, right now, to improve th

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-04 Thread Germán Poo-Caamaño
On Thu, 2014-09-04 at 19:50 +0200, Frederic Peters wrote: > [] > No, I think the obstacle is that we don't have enough people willing > to work on developer documentation over something else, even though > many will recognize the importance it has. It's not new. Touché. -- Germán Poo-Caamaño

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-04 Thread Jasper St. Pierre
While I'm sure a dynamic site would be a great idea in the far future, are there any small, actionable goals we can make for this? We all dream of a great docs scenario, but we never properly plan for it. What small wins can we get today, right now, to improve the experience? I have some free time

Re: Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-04 Thread Frederic Peters
Allan Day wrote: > However, before we go down that route, it seems like we should at > least discuss whether library-web is the best option going forward. It I would tend to put goals before technical details, but library-web as it is nowadays is certainly not the best option; I addressed a few o

Developer Docs Roadmap [was Re: Glade release to include GtkHeaderBar?]

2014-09-04 Thread Allan Day
Frederic Peters wrote: ... > Since the hackfest in Norwich in January it's possible to get specific > modules online (almost) directly after the git commits. It is > configured that way for gnome-user-docs and gnome-getting-started-docs > (for help. gnome.org) and for gnome-devel-docs (developer