You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@flink.apache.org by Ken Krugler <kk...@transpac.com> on 2018/04/16 19:17:20 UTC

Validating markdown doc files before creating a PR

Hi all,

I’m curious how devs check that their .md file edits are correct.

I've tried a few different plugins and command line utilities, but the mix of HTML and markdown has meant none of them render properly.

Thanks,

— Ken

--------------------------
Ken Krugler
http://www.scaleunlimited.com
custom big data solutions & training
Hadoop, Cascading, Cassandra & Solr

Re: Validating markdown doc files before creating a PR

Posted by Chesnay Schepler <ch...@apache.org>.

You can serve the documentation locally as described here 
<https://github.com/apache/flink/blob/master/docs/README.md#build>.

On 16.04.2018 21:17, Ken Krugler wrote:
> Hi all,
>
> I’m curious how devs check that their .md file edits are correct.
>
> I've tried a few different plugins and command line utilities, but the mix of HTML and markdown has meant none of them render properly.
>
> Thanks,
>
> — Ken
>
> --------------------------
> Ken Krugler
> http://www.scaleunlimited.com
> custom big data solutions & training
> Hadoop, Cascading, Cassandra & Solr
>
>