[NaCl SDK] Porting the "Getting Started" tutorial to ReST.

[NaCl SDK] Porting the "Getting Started" tutorial to ReST.

NOTE: this is just porting to ReST, I haven't updated anything to PNaCl yet.

BUG=none
R=eliben@chromium.org

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=221282

[eliben, 2013-09-04 20:00:52]

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
File native_client_sdk/src/doc/devguide/tutorial.rst (right):

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:5: ########################
These should be the same length as the text above/below them (the title text).
Hasn't Sphinx been complaining?

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:10: :depth: 1
I think it makes sense to consistently set it to 2 everywhere? Is there a
special reason you think 1 is better here?

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:25: A Native Client web
application consists of at least three parts:
I have this in the technical overview too. Once we have them both in place we
should not forget to make this part consistent :)

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:27: * **a web page** (\*.html)
How do you expect this to be formatted? If you want a new paragraph then a blank
line is needed after this line. Also, why start with a lowercase letter?

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:30: * **a Native Client module**
(\*.c or \*.cc before compiling; \*.nexe after
Ah, so it's just ReST translation, no PNaCl yet?

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:73: Step 1: Download and install
the Native Client SDK, Python, and Xcode Developer Tools (if necessary).
The title should probably be shorter

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:93: Step 2: Start a local
server.
Should title really end with periods?

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:114: cd pepper_28/examples
use naclcode with :prettyprint: 0 for all these

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:357: function moduleDidLoad() {
.. naclcode::

[binji, 2013-09-04 20:49:40]

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
File native_client_sdk/src/doc/devguide/tutorial.rst (right):

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:5: ########################
On 2013/09/04 20:00:52, eliben wrote:
> These should be the same length as the text above/below them (the title text).
> Hasn't Sphinx been complaining?

Ah, it does but I didn't notice it :)
done.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:10: :depth: 1
On 2013/09/04 20:00:52, eliben wrote:
> I think it makes sense to consistently set it to 2 everywhere? Is there a
> special reason you think 1 is better here?

That is the way the current document displays it.

It doesn't change too much to use depth 2, however:

Overview
  Parts in a Native Client application
  What the application in this tutorial does
  Communication between JavaScript code and Native Client modules
Step 1
Step 2...

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:25: A Native Client web
application consists of at least three parts:
On 2013/09/04 20:00:52, eliben wrote:
> I have this in the technical overview too. Once we have them both in place we
> should not forget to make this part consistent :)

Added a TODO.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:27: * **a web page** (\*.html)
On 2013/09/04 20:00:52, eliben wrote:
> How do you expect this to be formatted? If you want a new paragraph then a
blank line is needed after this line.
Done. Though it looks more "spread out" than in the original doc. Probably not a
big deal.

> Also, why start with a lowercase letter?
That's the way the current doc looks. I'll change it.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:30: * **a Native Client module**
(\*.c or \*.cc before compiling; \*.nexe after
On 2013/09/04 20:00:52, eliben wrote:
> Ah, so it's just ReST translation, no PNaCl yet?

Yes, I'll mention that in the CL description.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:73: Step 1: Download and install
the Native Client SDK, Python, and Xcode Developer Tools (if necessary).
On 2013/09/04 20:00:52, eliben wrote:
> The title should probably be shorter

Done.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:93: Step 2: Start a local
server.
On 2013/09/04 20:00:52, eliben wrote:
> Should title really end with periods?

Seems strange to me too. Done.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:114: cd pepper_28/examples
On 2013/09/04 20:00:52, eliben wrote:
> use naclcode with :prettyprint: 0 for all these

Done.

https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
native_client_sdk/src/doc/devguide/tutorial.rst:357: function moduleDidLoad() {
On 2013/09/04 20:00:52, eliben wrote:
> .. naclcode::

Done.

[eliben, 2013-09-04 20:59:06]

On 2013/09/04 20:49:40, binji wrote:
>
https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
> File native_client_sdk/src/doc/devguide/tutorial.rst (right):
> 
>
https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
> native_client_sdk/src/doc/devguide/tutorial.rst:5: ########################
> On 2013/09/04 20:00:52, eliben wrote:
> > These should be the same length as the text above/below them (the title
text).
> > Hasn't Sphinx been complaining?
> 
> Ah, it does but I didn't notice it :)
> done.
> 
>
https://codereview.chromium.org/23902007/diff/1/native_client_sdk/src/doc/dev...
> native_client_sdk/src/doc/devguide/tutorial.rst:10: :depth: 1
> On 2013/09/04 20:00:52, eliben wrote:
> > I think it makes sense to consistently set it to 2 everywhere? Is there a
> > special reason you think 1 is better here?
> 
> That is the way the current document displays it.

This is probably because hand-coding a single-depth TOC in HTML was gruesome
enough ;-) ISTM that 2 levels improves usability a bit.

> 
> It doesn't change too much to use depth 2, however:
> 
> Overview
>   Parts in a Native Client application
>   What the application in this tutorial does
>   Communication between JavaScript code and Native Client modules
> Step 1
> Step 2...
>

[eliben, 2013-09-04 20:59:12]

lgtm

[binji, 2013-09-04 22:36:26]

Committed patchset #3 manually as r221282 (presubmit successful).