Re: Documentation - language default



Michael Hall <mhall119 gmail com> wrote:
...
We have a project
on GNOME's Gitlab, a Telegram channel, and have been trying to hold regular
meetings on it.

This is all news to me... it would have been good to have heard about
the initiative sooner - I've been involved in quite a few discussions
about GNOME's developer documentation over the years, and have done a
fair amount of work on developer documentation design in the past [1]
(this came out of a meeting we had at GUADEC in 2016), including
creating a new prototype site last year.

Have you spoken with any of the relevant maintainers, like Shaun
McCance, Frederic Peters, or David King? Christian Hergert's also done
some work around developer documentation...

using Django CMS and are working on getting an instance up
and running
...
It would be helpful to have some more information about this.
...
We chose this primarily because it was used by the Ubuntu Developer Portal
in the past and we know it will work for the intended purpose. When I was
working on the Ubuntu site we considered various other options, but Django
CMS had the best combination of multi-language support, online editing,
staged editing, content management and scalability. API documentation will
be imported into Django (code for this was written for the Ubuntu portal
already) to be integrated with the rest of the site. Content is stored in
the Django database (it is a CMS after all). Contributors can be given login
access to draft changes that an admin can publish.

Thanks for this. As someone who's active on the developer
documentation side, I would really appreciate it if there was a write
up of the goals for this project, along with what you have in mind for
the final product.

Allan
--
[1] https://wiki.gnome.org/Design/Whiteboards/DeveloperDocs


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]