From 2323fe2a82eaca603b285a6192a588e4646e2628 Mon Sep 17 00:00:00 2001 From: Joe Gregorio Date: Thu, 4 Jan 2018 16:43:36 -0500 Subject: 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 Reviewed-by: Ben Wagner --- site/dev/tools/markdown.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'site/dev') 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: -- cgit v1.2.3