But what if the code changes - do we keep adding new gist's? I sort of
prefer the markdown option since it will evolve correctly with the code and
be versioned like all the rest of our documentation. What about including a
reference to the md file in the docstring?


On Tue, Feb 19, 2013 at 10:35 AM, Tathagata Das <notifications@github.com>wrote:

> In docs/zeroMQ-intro.md:
>
> > @@ -0,0 +1,59 @@
> > +---
> > +layout: global
> > +title: ZeroMQ Stream setup guide
> > +---
> > +
> > +## Install ZeroMQ (using JNA)
>
> Instead of having a separate markdown doc which people may not know about,
> can add the gist of this (basically installation instructions) in the
> comments of ZeroMQWordCount example? In that way they will not have to hunt
> around for more instruction, the zeroMQ word count will be self explanatory.
>
> —
> Reply to this email directly or view it on GitHub<https://github.com/mesos/spark/pull/479/files#r3067061>.
>
>