diff options
| author |  Joe Gregorio <jcgregorio@google.com> | 2018-01-04 16:43:36 -0500 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-01-05 19:37:19 +0000 |
| commit | 2323fe2a82eaca603b285a6192a588e4646e2628 (patch) | |
| tree | f44407d1cfdd78df679f3ebf0f72c6adc7cc576f /site/dev | |
| parent | d208a8847777d4643188813f03a15dfed4887365 (diff) | |
Update docs on how to build and run docserver.
No-Try: true
Docs-Preview: https://skia.org/?cl=90943
Bug: skia:7444
Change-Id: I603e629a2a2a799c9f2ea699cbfb6f6533da327b
Reviewed-on: https://skia-review.googlesource.com/90943
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Ben Wagner <benjaminwagner@google.com>
Diffstat (limited to 'site/dev')
| -rw-r--r-- | site/dev/tools/markdown.md | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/site/dev/tools/markdown.md b/site/dev/tools/markdown.md index 939e8a32c7..8f1198a074 100644 --- a/site/dev/tools/markdown.md +++ b/site/dev/tools/markdown.md @@ -13,12 +13,19 @@ with the value of the Reitveld issue id: https://skia.org/path/to/markdown-file?cl=REITVELD_ISSUE_NUMBER -You can also run a local copy of the documentation server, which will allow -you to preview changes much quicker. You must have [Go](https://golang.org) -installed on your computer, which you will have if you are running on a Google -corporate workstation. Run: - - go get -u skia.googlesource.com/buildbot.git/doc/go/docserver +This is the preferred method of previewing docs changes. + +If for some reason you can't use the method above to preview docs changes you +can also run a local copy of the documentation server, which will allow you to +preview changes much quicker. You must have a recent version (>=8.9) of +[node](https://nodejs.org/) installed on your machine. You must also have +[Go](https://golang.org) installed on your computer, which you will have if +you are running on a Google corporate workstation. Installation also means +that you have `$GOPATH/bin` [added to your PATH](https://golang.org/doc/code.html#GOPATH). Run: + + go get -u go.skia.org/infra/doc/go/docserver + cd $GOPATH/src/go.skia.org/infra/doc + make And then **from within** the directory of your local Git checkout of Skia run: |