warn that docs/quickstart.md is out of sync with official docs

warn that docs/quickstart.md is out of sync with official docs

(SkipBuildbotRuns)
NOTREECHECKS=True
NOTRY=True
TBR=borenet

Committed: http://code.google.com/p/skia/source/detail?r=14287

[epoger, 2014-04-21 15:36:11]

PTAL.

[mtklein, 2014-04-21 15:37:11]

On 2014/04/21 15:36:11, epoger wrote:
> PTAL.

Let's change quickstart.md to be what you want and redirect the other site to
it?

[epoger, 2014-04-21 15:40:43]

On 2014/04/21 15:37:11, mtklein wrote:
> On 2014/04/21 15:36:11, epoger wrote:
> > PTAL.
> 
> Let's change quickstart.md to be what you want and redirect the other site to
> it?

I'm in favor of moving some documentation into markup, if it works for Heather
(who is leading the work on improving user documentation as a whole).

There are obstacles, such as where is the markup-maintained documentation easily
viewable as HTML?

These are not huge obstacles, but in the meanwhile, I think we should mark this
as experimental ASAP.

[mtklein, 2014-04-21 15:44:17]

> There are obstacles, such as where is the markup-maintained documentation
easily
> viewable as HTML?

https://github.com/google/skia/tree/master/docs
https://github.com/google/skia/blob/master/docs/quickstart.md

Note this is not raw.github.com, and won't be throttled.  Unlike generic file
serving, GitHub encourages serving Markdown as HTML as a feature.  :)

[epoger, 2014-04-21 15:48:47]

On 2014/04/21 15:44:17, mtklein wrote:
> > There are obstacles, such as where is the markup-maintained documentation
> easily
> > viewable as HTML?
> 
> https://github.com/google/skia/tree/master/docs
> https://github.com/google/skia/blob/master/docs/quickstart.md
> 
> Note this is not http://raw.github.com, and won't be throttled.  Unlike
generic file
> serving, GitHub encourages serving Markdown as HTML as a feature.  :)

Thanks.  I would encourage you to show that to Heather, and find out whether
that is a suitable presentation for our docs.  Seems fine to me, but some people
may object to the GitHub "framing" around the content, or the fact that it is
hosted at GitHub, I have no idea.

Anyway, my desire to mark this as experimental ASAP remains.

[epoger, 2014-04-21 15:53:26]

Putting it another way: if there is significant HARM in marking these steps as
experimental right now, please let me know.

Otherwise, I will commit the change.

Moving things to markdown can happen later.

[hcm, 2014-04-21 16:25:10]

On 2014/04/21 15:53:26, epoger wrote:
> Putting it another way: if there is significant HARM in marking these steps as
> experimental right now, please let me know.
> 
> Otherwise, I will commit the change.
> 
> Moving things to markdown can happen later.

Thanks for tapping me in... I will take back up the markdown conversation with
you guys offline for a bit deeper discussion.  When I reviewed it previously and
spoke to a small group of Skia leads and Dev Rel writers who were helping me
with the new site/docs plan, there was some desire to focus on "bigger problems"
first like making current docs accurate while keeping the barrier extremely low
for editing (ie not requiring Skia checkout/commit).  We have also been using
the simple page creation and formatting provided by the Google Sites for
Business editor for new pages.. so I need to think through converting to
markdown and continuing to use that for additions.

[epoger, 2014-04-21 19:18:07]

I don't hear anyone warning of harmful effects, so committing.

[epoger, 2014-04-21 19:18:11]

The CQ bit was checked by epoger@google.com

[commit-bot: I haz the power, 2014-04-21 19:18:22]

CQ is trying da patch. Follow status at
https://skia-tree-status.appspot.com/cq/epoger@google.com/245283002/1

[commit-bot: I haz the power, 2014-04-21 19:18:52]

Change committed as 14287