Commit Graph

35 Commits

Author SHA1 Message Date
Ravi Mistry
2c98edf07f Spelling and capitalization fixes from GitHub PRs
Inspired by
* https://github.com/google/skia/pull/18
* https://github.com/google/skia/pull/22

Change-Id: I4c092978f928ff2f589b6440d1fcdd846fa2b56f
Docs-Preview: https://skia.org/?cl=342925
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/342925
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Ravi Mistry <rmistry@google.com>
2020-12-10 18:40:09 +00:00
John Stiles
994ce8cf23 Add a dev tools section about debug visualizers.
Change-Id: Ib866d7b8fa2b30bad0716ce9649fa8d9eaab1e41
No-Try: true
Docs-Preview: https://skia.org/?cl=306723
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/306723
Auto-Submit: John Stiles <johnstiles@google.com>
Reviewed-by: Mike Klein <mtklein@google.com>
Commit-Queue: John Stiles <johnstiles@google.com>
2020-07-29 21:15:43 +00:00
Leon Scroggins III
1ff07066f9 Remove more references to "master"
Bug: chromium:1101491
Bug: b/161896447

Switch to more inclusive language, like "main", or remove where
simply unnecessary.

Change-Id: I36ef6ec631eb991f54f42b98887333f07c0984c2
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/306060
Commit-Queue: Leon Scroggins <scroggo@google.com>
Reviewed-by: Mike Klein <mtklein@google.com>
Reviewed-by: Kevin Lubick <kjlubick@google.com>
2020-07-28 13:06:07 +00:00
Nathaniel Nifong
732248c2f1 Use html tags instead of markdown for images in debugger user guide
No-Try: true
Docs-Preview: https://skia.org/?cl=266559
Change-Id: Ib1945f2f6380511d1657437e99859fb79f88529c
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/266559
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Nathaniel Nifong <nifong@google.com>
2020-01-27 13:41:45 +00:00
Nathaniel Nifong
a8352ccaae Write a debugger user guide.
No-Try: true
Docs-Preview: https://skia.org/?cl=261088
Change-Id: I5d049ca0ee71a7bb10ff70c71b2a92604a034831
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/261088
Commit-Queue: Nathaniel Nifong <nifong@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
2019-12-19 17:29:49 +00:00
Ben Wagner
9c17be5301 [infra] Update docs with respect to Go modules.
Docs-Preview: https://skia.org/?cl=255085
Change-Id: I8911862ca9814b89b8598ad743b1faa9c524399f
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/255085
Commit-Queue: Ben Wagner aka dogben <benjaminwagner@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Eric Boren <borenet@google.com>
Auto-Submit: Ben Wagner aka dogben <benjaminwagner@google.com>
2019-11-18 18:04:19 +00:00
Joe Gregorio
f8813913ba [docs] - Add link to buildbot search.
No-Try: true
Docs-Preview: https://skia.org/?cl=249426
Change-Id: I75e12f90a6b52cd13b9f8fc2741d610c47293d88
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/249426
Auto-Submit: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Heather Miller <hcm@google.com>
2019-10-18 17:14:22 +00:00
Mike Klein
4941a2239e switch some idiosyncratic <includes> to ""
Change-Id: I099f8a635df7dd0ddd3902459615250ea2c120c5
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/209874
Commit-Queue: Mike Klein <mtklein@google.com>
Reviewed-by: Mike Klein <mtklein@google.com>
2019-04-23 17:54:48 +00:00
Brian Osman
1345366c21 Update tracing docs slightly
Prioritize "Chrome Tracing", and rename it to not sound like it's
specific to Skia-in-Chrome. Also mention the 256 MB file size limit.
Include basic trace event example, and link to more thorough docs
in the code.

No-Try: true
Docs-Preview: https://skia.org/?cl=188306
Bug: skia:
Change-Id: I882f2a81dfcce33847029f0800b27baa2f98308d
Reviewed-on: https://skia-review.googlesource.com/c/188306
Auto-Submit: Brian Osman <brianosman@google.com>
Reviewed-by: Heather Miller <hcm@google.com>
Commit-Queue: Heather Miller <hcm@google.com>
2019-01-31 19:10:53 +00:00
Ben Wagner
bb9844ef69 Add client code search to docs.
Also, history seems to be available for internal code search.

No-Try: true
Docs-Preview: https://skia.org/?cl=171003
Change-Id: I13707664b88e3d84760f11f43d2bd7c35c2a8969
Reviewed-on: https://skia-review.googlesource.com/c/171003
Commit-Queue: Ben Wagner <benjaminwagner@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
Auto-Submit: Ben Wagner <benjaminwagner@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
2018-11-14 17:37:44 +00:00
Andrew Monshizadeh
9d6681cc70 Changes to site documentation
Mostly just formatting fixes with a few grammatical changes.

Two real notable changes:
  - Removed references to SkGLCanvas from Tips & FAQ and replaced with
    references to `SkDevice` and `SkSurface`.
  - Deleted deprecated "Quick Start Guides" folder

Docs-Preview: https://skia.org/?cl=92361
Bug: skia:
Change-Id: Ief790b1c2bae8fe0e39aa8d66c79f80560d18c9e
Reviewed-on: https://skia-review.googlesource.com/92361
Reviewed-by: Heather Miller <hcm@google.com>
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2018-01-11 19:47:58 +00:00
Joe Gregorio
2323fe2a82 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>
2018-01-05 19:37:19 +00:00
Brian Osman
c3cdef5fb0 Add top-level trace markers for each benchmark
Also add new paragraph about using systrace correctly

Docs-Preview: https://skia.org/?cl=41502
Change-Id: I114c14cc2e87a8b72aec46d8c354d3ea877a41ab
Reviewed-on: https://skia-review.googlesource.com/41502
Reviewed-by: Mike Klein <mtklein@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
2017-08-31 18:36:51 +00:00
Brian Osman
1627c04d86 Quick documentation of tracing support in our tools
No-Try: true
Docs-Preview: https://skia.org/?cl=26260
Bug: skia:
Change-Id: I3cf09f1c94cdc9551ece44da022ef2c2f374d6e4
Reviewed-on: https://skia-review.googlesource.com/26260
Commit-Queue: Brian Osman <brianosman@google.com>
Reviewed-by: Mike Klein <mtklein@chromium.org>
2017-07-24 17:25:05 +00:00
Ben Wagner
33064926c7 Update codesearch docs.
BUG=skia:

NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=8321

Change-Id: Ia8c87fbb3b2380c18d27bffbbd060a0d77194f7d
Reviewed-on: https://skia-review.googlesource.com/8321
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Ben Wagner <benjaminwagner@google.com>
2017-02-10 21:47:45 +00:00
Hal Canary
a4a3381790 tools and docs: clean up gyp-specific things
BUG=skia:

DOCS_PREVIEW= https://skia.org/?cl=5770

Change-Id: Iadc436a68cbf7ec0d1dd3c019072eb28bf589bb6
Reviewed-on: https://skia-review.googlesource.com/5770
Commit-Queue: Hal Canary <halcanary@google.com>
Reviewed-by: Mike Klein <mtklein@chromium.org>
2016-12-09 21:15:27 +00:00
Joe Gregorio
87da4efd63 docs: Use the new floating ment on skpaint.md
Screenshot:
  https://screenshot.googleplex.com/C3E0hpuNwdu.png
  https://screenshot.googleplex.com/vdfQMRc24Nv.png

BUG=skia:

NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=5757

Change-Id: I00b1bb01cab05592d19f020f3190576bf7907aa2
Reviewed-on: https://skia-review.googlesource.com/5757
Reviewed-by: Hal Canary <halcanary@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2016-12-09 16:43:56 +00:00
liyuqian
21112deff8 Fix typo
BUG=skia:
GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2370003002
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=2370003002

Review-Url: https://codereview.chromium.org/2370003002
2016-09-26 12:49:06 -07:00
pdr
48898561db Update markdown docs to specify --local for the local devserver
If the devserver is run locally following the instructions on
https://skia.org/dev/tools/markdown, you'll get an error about influxdb.
It looks like an influxdb username/password is required but using
--local works around this issue.

-------------------8<-------------------
$ ./bin/docserver --preview
E0703 19:33:31.510379   30448 common.go:37] Initializing logserver for log level ERROR.
F0703 19:33:31.516750   30448 common.go:63] metadata.Get() failed to make HTTP request for influxdb_name: Get http://metadata/computeMetadata/v1/project/attributes/influxdb_name: dial tcp: lookup metadata: no such host
goroutine 1 [running]:
github.com/skia-dev/glog.stacks(0x772300, 0x0, 0x0, 0x0)
    /src/github.com/skia-dev/glog/glog.go:769 +0xb8
github.com/skia-dev/glog.(*loggingT).output(0x756000, 0xc800000003, 0xc820136000, 0x73613e, 0x9, 0x3f, 0x0)
    /src/github.com/skia-dev/glog/glog.go:720 +0x259
github.com/skia-dev/glog.(*loggingT).printDepth(0x756000, 0x3, 0x1, 0xc8200dde28, 0x1, 0x1)
    /src/github.com/skia-dev/glog/glog.go:649 +0x1b8
github.com/skia-dev/glog.(*loggingT).print(0x756000, 0x3, 0xc8200dde28, 0x1, 0x1)
    /src/github.com/skia-dev/glog/glog.go:640 +0x50
github.com/skia-dev/glog.Fatal(0xc8200dde28, 0x1, 0x1)
    /src/github.com/skia-dev/glog/glog.go:1128 +0x49
go.skia.org/infra/go/common.StartMetrics2(0x5103e0, 0x9, 0xc820104400, 0xc820104430, 0xc820104450, 0xc820104470, 0xc8200dde00)
    /src/go.skia.org/infra/go/common/common.go:63 +0x192
go.skia.org/infra/go/common.InitWithMetrics2(0x5103e0, 0x9, 0xc820104400, 0xc820104430, 0xc820104450, 0xc820104470, 0xc820104498)
    /src/go.skia.org/infra/go/common/common.go:48 +0x65
main.main()
    /src/skia.googlesource.com/buildbot.git/doc/go/docserver/main.go:183 +0x95
-------------------8<-------------------

GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2118113002
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=2118113002

Review-Url: https://codereview.chromium.org/2118113002
2016-07-09 17:08:24 -07:00
pdr
c42475cea2 Update markdown to use absolute image paths, fixing broken images
Markdown can be served with or without a trailing slash but when a
trailing slash is present, relative image links were broken.

The following example works as expected:
url: https://skia.org/dev/design/pdftheory
image url: PdfLogicalDocumentStructure.png
resolves to: https://skia.org/dev/design/PdfLogicalDocumentStructure.png

The following example was broken before this patch:
url: https://skia.org/dev/design/pdftheory/
image url: PdfLogicalDocumentStructure.png
resolves to: https://skia.org/dev/design/pdftheory/PdfLogicalDocumentStructure.png

The PdfLogicalDocumentStructure.png file lives in /dev/design/, not
/dev/design/pdftheory/. This patch updates all images in our markdown
files to be served with the full path so a trailing slash no longer
breaks images.

I hit this bug when promoting the new Skia debugger:
https://groups.google.com/a/chromium.org/d/msg/paint-dev/QJ8xpu8dNyA/F4KX2O4ZBwAJ

BUG=skia:5493
GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2128013003
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=2128013003

Review-Url: https://codereview.chromium.org/2128013003
2016-07-07 14:48:53 -07:00
pdr
1e2a702c19 Update dev docs to reference the new skia debugger (skiaserve)
This patch adds a new markdown file describing the new debugger along
with instructions on running it locally and a sweet screenshot. The
screenshot has been sized to not be clipped when viewed in production.

The old documentation for the qt-based debugger has been marked as
deprecated and all docs referencing the old debugger have been updated.

BUG=skia:5493
GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2121673002
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=2121673002

Review-Url: https://codereview.chromium.org/2121673002
2016-07-06 06:10:25 -07:00
halcanary
e0c64c5846 Documentation: clean up
-   /user/quick/desktop to bring together all common information for
    using Skia on desktop OSes.  Remove duplication.

-   Replace all instances of call ing gyp_skia directly with calling
    `python bin/sync-and-gyp`.  This is more correct on Windows

-   Remove outdated linux prerequisite packages

-   Formatting, formatting, formatting.

-   Note command-line syntax differences in Windows

-   SampleApp.app is no longer a bundle on MacOS

NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1439493003

Review URL: https://codereview.chromium.org/1439493003
2015-11-13 04:29:59 -08:00
hcm
6065d8eae6 Adding Skia Debugger documentation
BUG=skia:
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1414393010

Review URL: https://codereview.chromium.org/1414393010
2015-11-06 11:29:06 -08:00
benjaminwagner
e8dc3f2f0b Move code search info to sub-page. Add additional code search options.
BUG=skia:
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1375523003

Review URL: https://codereview.chromium.org/1375523003
2015-09-28 11:15:09 -07:00
benjaminwagner
474df7fc03 Add documentation of cs.skia.org.
BUG=skia:
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1332303005

Review URL: https://codereview.chromium.org/1332303005
2015-09-15 07:02:02 -07:00
hcm
95d79132cf Move Perf documentation to the testing section
BUG=skia:
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=1280533003

Review URL: https://codereview.chromium.org/1280533003
2015-08-11 07:00:01 -07:00
jcgregorio
71b03e468d Add some METADATA files to control docs layout.
BUG=skia:3484
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=976303002

Review URL: https://codereview.chromium.org/976303002
2015-03-05 07:11:13 -08:00
tfarina
3b7f7b092c Fix the URL for previewing Markdown changes.
BUG=None
R=jcgregorio@google.com
NOTRY=true

Review URL: https://codereview.chromium.org/883003004
2015-02-04 06:05:58 -08:00
jcgregorio
879140da74 Add docs for running docserver locally.
BUG=skia:3346

Review URL: https://codereview.chromium.org/891483002
2015-01-29 09:55:14 -08:00
jcgregorio
1d124c3142 Add docs on how to get a preview of markdown pages.
BUG=skia:

Review URL: https://codereview.chromium.org/878593002
2015-01-26 07:24:02 -08:00
tfarina
0004e7db42 Update references to skiaperf.com.
The new server is being run in perf.skia.org.

BUG=None
R=jcgregorio@google.com

Review URL: https://codereview.chromium.org/866943003
2015-01-26 06:47:55 -08:00
jcgregorio
0f2e055580 Add docs for prettify.
Preview here: http://skia.org/dev/tools/markdown?cl=862933002

BUG=skia:

Review URL: https://codereview.chromium.org/862933002
2015-01-21 08:02:45 -08:00
jcgregorio
bd2059a02a fix link reference in docs
BUG=skia:
NOTRIES=1
TBR=halcanary

Review URL: https://codereview.chromium.org/853703003
2015-01-14 12:03:01 -08:00
jcgregorio
0c2dc21a58 Add reference material for the style of markdown we use.
Preview here: http://skiadocs.com:8000/dev/tools/markdown?cl=853493004

Note that the image won't show up, that's a known issue with the way patching in CLs works.

BUG=skia:

Review URL: https://codereview.chromium.org/853493004
2015-01-14 11:26:30 -08:00
jcgregorio
a91dc3140c Document some skia perf interesting queries.
Preview here: http://skiadocs.com:8000/dev/tools/skiaperf?cl=839303002

BUG=skia:

Review URL: https://codereview.chromium.org/839303002
2015-01-09 10:35:52 -08:00