migrate GN docs from the wiki to the repo.

Migrate GN docs from the wiki to the repo.

Given that Google Code is shutting down, we need to figure out what to do with docs in the wiki. Gitiles (the tree browser for our Git repo) supports rendering markdown files that are checked in to the repo, so one obvious answer is to migrate the GN docs into the repo (and convert them to markdown); this would also make it easier to keep the docs versioned and in sync with the code.

This is a first pass at that. The content is unchanged from the wiki, just converted and manually reformatted to stay within 80 columns where possible (we can't do that for long URLs or wide tables).

R=brettw@chromium.org, scottmg@chromium.org
BUG=468851
Committed: https://crrev.com/12a4235cfacb206ffc7ba27dd14edd970e5b60e0
Cr-Commit-Position: refs/heads/master@{#323923}

[Dirk Pranke, 2015-04-02 22:37:55]

dpranke@chromium.org changed reviewers:
+ brettw@chromium.org

[Dirk Pranke, 2015-04-03 02:59:13]

split md_browser out into its own dir

[Dirk Pranke, 2015-04-03 03:17:29]

dpranke@chromium.org changed reviewers:
+ scottmg@chromium.org

[Dirk Pranke, 2015-04-03 03:17:41]

Patchset #1 (id:1) has been deleted

[Dirk Pranke, 2015-04-03 03:17:50]

Patchset #1 (id:20001) has been deleted

[Dirk Pranke, 2015-04-03 03:17:57]

Patchset #1 (id:40001) has been deleted

[Dirk Pranke, 2015-04-03 03:18:04]

Patchset #1 (id:60001) has been deleted

[Dirk Pranke, 2015-04-03 03:20:31]

Please take a look?

Unfortunately, we don't have great methods for previewing what the rendered
markdown will look like yet.

I've posted a separate CL --https://codereview.chromium.org/1059673002/ -- that
adds a simple Python web server that will render files in a local checkout
relatively close to how Gitiles will render them, which can be useful, or you
can run a local Gitiles instance  (requires Java and Buck, and may not run on
non-Linux machines).

We might just want to land and iterate, however (and of course, you can just
read the markdown as text).

[tfarina, 2015-04-03 03:57:01]

On Friday, April 3, 2015, <dpranke@chromium.org> wrote:

> Please take a look?
>
> Unfortunately, we don't have great methods for previewing what the rendered
> markdown will look like yet.
>
> Skia built a docserver for this use case. Maybe we could get one in
infra/infra?

https://skia.org/dev/tools/markdown

>

> I've posted a separate CL --https://codereview.chromium.org/1059673002/
> -- that
> adds a simple Python web server that will render files in a local checkout
> relatively close to how Gitiles will render them, which can be useful, or
> you
> can run a local Gitiles instance  (requires Java and Buck, and may not run
> on
> non-Linux machines).
>
> We might just want to land and iterate, however (and of course, you can
> just
> read the markdown as text).
>
> https://codereview.chromium.org/1052883002/
>


-- 
Thiago Farina

To unsubscribe from this group and stop receiving emails from it, send an email
to chromium-reviews+unsubscribe@chromium.org.

[brettw, 2015-04-06 18:09:10]

LGTM rubberstamp

[Dirk Pranke, 2015-04-06 18:11:30]

On 2015/04/03 03:57:01, tfarina wrote:
> > Skia built a docserver for this use case. Maybe we could get one in
> infra/infra?
> 
> https://skia.org/dev/tools/markdown

I'll look into that, thanks! As I noted, I wrote a separate thing in Python
(Skia's is in Go), 
but we may be able to share things.

[Dirk Pranke, 2015-04-06 18:11:37]

The CQ bit was checked by dpranke@chromium.org

[commit-bot: I haz the power, 2015-04-06 18:12:22]

CQ is trying da patch. Follow status at
 https://chromium-cq-status.appspot.com/patch-status/1052883002/80001

[commit-bot: I haz the power, 2015-04-06 18:42:39]

Committed patchset #1 (id:80001)

[commit-bot: I haz the power, 2015-04-06 18:43:44]

Patchset 1 (id:??) landed as
https://crrev.com/12a4235cfacb206ffc7ba27dd14edd970e5b60e0
Cr-Commit-Position: refs/heads/master@{#323923}

[Nico, 2017-03-20 14:19:23]

thakis@chromium.org changed reviewers:
+ thakis@chromium.org

[Nico, 2017-03-20 14:19:26]

https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalon...
File tools/gn/docs/standalone.md (right):

https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalon...
tools/gn/docs/standalone.md:41: # How the standalone and Chrome builds interact
This looks truncated. Pasteboard mishap?

(I noticed 'cause some internal doc --
https://docs.google.com/document/d/1i9MsSl6Y14dG0kA8FFcNBaFdMoDee2kUPg3pEH7HK...
-- pointed out that this file here isn't super helpful.)

It probably should mention tools/gn/example at least, but if you know how to
restore what was originally in this document on the wiki that'd probably be
best.

[Dirk Pranke, 2017-03-21 00:07:10]

On 2017/03/20 14:19:26, Nico wrote:
>
https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalon...
> File tools/gn/docs/standalone.md (right):
> 
>
https://codereview.chromium.org/1052883002/diff/80001/tools/gn/docs/standalon...
> tools/gn/docs/standalone.md:41: # How the standalone and Chrome builds
interact
> This looks truncated. Pasteboard mishap?
> 
> (I noticed 'cause some internal doc --
>
https://docs.google.com/document/d/1i9MsSl6Y14dG0kA8FFcNBaFdMoDee2kUPg3pEH7HK...
> -- pointed out that this file here isn't super helpful.)
> 
> It probably should mention tools/gn/example at least, but if you know how to
> restore what was originally in this document on the wiki that'd probably be
> best.

Hm, good catch. From looking at what the internet archive has, it looks like
that's
actually more-or-less what the page said since day one, i.e., the page always
had
that line at the end and nothing more. Perhaps brettw@ wrote it as a placeholder
and never got back to it. I'm not actually sure what all you'd put in here since
the answer
is just "not at all".

I'll post a CL to just delete the line and glance over the rest of the text.