Commit 394b907a authored by Vincent Scheib's avatar Vincent Scheib Committed by Commit Bot

Document how to review documentation via gerrit and gitiles.

TBR: scheib@chromium.org
Change-Id: Id7dfb8b7163c3c87ed71c0257187850ad97c6c3c
Reviewed-on: https://chromium-review.googlesource.com/572236Reviewed-by: default avatarVincent Scheib <scheib@chromium.org>
Commit-Queue: Vincent Scheib <scheib@chromium.org>
Cr-Commit-Position: refs/heads/master@{#486912}
parent 3f00ffcc
...@@ -11,27 +11,30 @@ below. ...@@ -11,27 +11,30 @@ below.
[TOC] [TOC]
## Style guide ## Creating Documentation
Markdown documents must follow the Markdown documents must follow the
[style guide](https://github.com/google/styleguide/tree/gh-pages/docguide). [style guide](https://github.com/google/styleguide/tree/gh-pages/docguide).
## Previewing changes ### Preview local changes using [md_browser](../tools/md_browser/):
You can preview your local changes using [md_browser](../tools/md_browser/):
```bash ```bash
# in chromium checkout # in chromium checkout
./tools/md_browser/md_browser.py ./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 ### Review changes online with gerrit's links to gitiles:
# in chromium checkout
git cl patch <CL number or URL> 1. Upload a patch to gerrit, or receive a review request.
./tools/md_browser/md_browser.py 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 ## Document Index
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment