Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Richard Purdie" <richard.purdie@linuxfoundation.org>
To: "docs@lists.yoctoproject.org" <docs@lists.yoctoproject.org>
Cc: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Subject: Possible changes to the project docs
Date: Wed, 15 Apr 2020 11:19:25 +0100	[thread overview]
Message-ID: <135fccacd4ee8a1ffe0e06f6f95c22e05dadf04a.camel@linuxfoundation.org> (raw)

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...

Cheers,

Richard






             reply	other threads:[~2020-04-15 10:19 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-15 10:19 Richard Purdie [this message]
2020-04-15 15:21 ` [docs] Possible changes to the project 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

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=135fccacd4ee8a1ffe0e06f6f95c22e05dadf04a.camel@linuxfoundation.org \
    --to=richard.purdie@linuxfoundation.org \
    --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