Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: "docs@lists.yoctoproject.org" <docs@lists.yoctoproject.org>
Cc: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Subject: Re: [docs] Possible changes to the project docs
Date: Thu, 16 Apr 2020 12:47:08 -0400 (EDT)	[thread overview]
Message-ID: <alpine.LFD.2.21.2004161242280.35575@localhost.localdomain> (raw)
In-Reply-To: <135fccacd4ee8a1ffe0e06f6f95c22e05dadf04a.camel@linuxfoundation.org>

On Wed, 15 Apr 2020, Richard Purdie wrote:

> Since Robert was talking about future docs wide changes, I wanted to
> put an idea out there. Its something a few of us have talked a
> little about. At this point it is an idea, not a decision and
> something we're thinking we need to explore and evaluate.
>
> Basically, the thought is whether to move from docbook to sphinx.
>
> Other projects like the kernel have switched and it could assist
> some of our website/publishing challenges. It might also be easier
> for people to contribute to and there are wider and more modern
> tools supporting that format.
>
> It'd be a big change, particularly if we consider we may need to
> convert previous releases of the docs as well as the current
> version. That said, if we were going to do this, the time could be
> now...

  ok, time to weigh in now that i have a minute ... i am totally on
board with a rewriting in sphinx, as that would not only make it
easier for others to contribute, but it's something that, given some
minimal direction, could be handed off to an intern of some kind or --
as i see already mentioned in subsequent replies -- fed through an
automatic translator (eg., pandoc).

  it would also be the right time to restructure some of the docs
(migration manual all on its own, etc, etc.).

  the only downside to the switch is that, as arcane as docbook and
xsl stylesheets can be at times, they do support pretty much infinite
and incredibly refined customization. however, i don't think the YP
docs really scream for that level of customization.

  i'm for it.

rday

      parent reply	other threads:[~2020-04-16 16:47 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-15 10:19 Possible changes to the project docs Richard Purdie
2020-04-15 15:21 ` [docs] " Trevor Woerner
2020-04-16 16:51   ` Robert P. J. Day
2020-04-16 17:00     ` Nicolas Dechesne
2020-04-16 17:46       ` Robert P. J. Day
2020-04-16 17:55         ` Nicolas Dechesne
2020-04-16 18:06           ` Robert P. J. Day
2020-05-21 20:41             ` Mark Morton
2020-05-25  7:33               ` Nicolas Dechesne
2020-05-26 10:43                 ` Nicolas Dechesne
2020-05-28  5:49                   ` Mark Van De Vyver
2020-05-28  7:54                     ` [docs] " Nicolas Dechesne
2020-05-28  8:23                       ` Robert P. J. Day
2020-05-28  8:29                       ` Robert P. J. Day
2020-05-28  8:47                         ` Nicolas Dechesne
2020-06-01  1:19                       ` Mark Van De Vyver
2020-06-12 11:52                   ` [docs] " Nicolas Dechesne
2020-06-15 19:52                     ` Nicolas Dechesne
2020-04-15 15:37 ` Nicolas Dechesne
2020-04-15 17:13   ` [docs] " akuster
2020-04-16 16:47 ` Robert P. J. Day [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=alpine.LFD.2.21.2004161242280.35575@localhost.localdomain \
    --to=rpjday@crashcourse.ca \
    --cc=docs@lists.yoctoproject.org \
    --cc=nicolas.dechesne@linaro.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox