From: "Mark Van De Vyver" <mark@taqtiqa.com>
To: docs@lists.yoctoproject.org
Subject: Documentation Linter
Date: Wed, 27 May 2020 21:00:12 -0700 [thread overview]
Message-ID: <XszS.1590638412302404292.hla4@lists.yoctoproject.org> (raw)
[-- Attachment #1: Type: text/plain, Size: 1179 bytes --]
Hi,
As mentioned in my previous message - which hasn't shown up yet - I'm new to Yocto and thought to try contribute via the docs.
I've made my comment on the conversion from DocBook, and this proposal will be impacted by that effort - hopefully a part of the conversion, and in a way that does not block or interfere.
The idea I had was to introduce a prose linting tool. Specifically, [Vale](https://errata-ai.gitbook.io/vale/).
Before going into the details, lets first establish if any of the following would be of use/value?
It would allow the project to achieve some consistency across paragraphs/pages/documents/repositories.
This would become more important if the project decided to exploit [Antora's](https://antora.org) ability to create a document from different repositories.
In such a case a repo could ensure its documentation had a closer 'fit' within the wider project documentation by ensuring it passed the same lint settings.
After the inital run/port is complete the documentation lint step could be added to the githooks that verify any new commit is green.
Thoughts?
--
Kind regards
Mark
Mark Van de Vyver, B.Bus(Hons), PhD(Dist)
[-- Attachment #2: Type: text/html, Size: 1296 bytes --]
next reply other threads:[~2020-05-28 4:00 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-28 4:00 Mark Van De Vyver [this message]
2020-05-28 15:51 ` [docs] Documentation Linter Khem Raj
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=XszS.1590638412302404292.hla4@lists.yoctoproject.org \
--to=mark@taqtiqa.com \
--cc=docs@lists.yoctoproject.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.