Document how to review documentation via gerrit and gitiles.
TBR: scheib@chromium.org
Change-Id: Id7dfb8b7163c3c87ed71c0257187850ad97c6c3c
Reviewed-on: https://chromium-review.googlesource.com/572236
Reviewed-by: Vincent Scheib <scheib@chromium.org>
Commit-Queue: Vincent Scheib <scheib@chromium.org>
Cr-Commit-Position: refs/heads/master@{#486912}diff --git a/docs/README.md b/docs/README.md
index 834732c..c611c2f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -11,27 +11,30 @@
[TOC]
-## Style guide
+## Creating Documentation
Markdown documents must follow the
[style guide](https://github.com/google/styleguide/tree/gh-pages/docguide).
-## Previewing changes
-
-You can preview your local changes using [md_browser](../tools/md_browser/):
+### Preview local changes using [md_browser](../tools/md_browser/):
```bash
# in chromium checkout
./tools/md_browser/md_browser.py
```
-To review someone else's changes, apply them locally first:
+This is only an estimate. The **gitiles** view may differ.
-```bash
-# in chromium checkout
-git cl patch <CL number or URL>
-./tools/md_browser/md_browser.py
-```
+### Review changes online with gerrit's links to gitiles:
+
+1. Upload a patch to gerrit, or receive a review request.
+ e.g. https://chromium-review.googlesource.com/c/572236
+2. View a specific .md file.
+ e.g. https://chromium-review.googlesource.com/c/572236/2/docs/README.md
+3. Click on **gitiles** link at top of page.
+
+This **gitiles** view is the authoritative view, exactly the same as will be
+used when committed.
## Document Index
