| commit | c42e592e89ec07b6317f5c901669fc20d1c17d9e | [log] [tgz] |
|---|---|---|
| author | Yiwei Zhang <yiwzhang@google.com> | Wed May 04 18:56:33 2022 |
| committer | Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed May 04 21:48:48 2022 |
| tree | f3925be980fbb58ece2555c6aff502ac95538a5b | |
| parent | 03602d02cb51524db10bb4964ab644399dcda06b [diff] |
contributing: Clarify the behavior for multiple CLs submission Change-Id: I2eb651480193a1d9044829b721625a1abc145b1f Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/3626582 Auto-Submit: Yiwei Zhang <yiwzhang@google.com> Commit-Queue: Yiwei Zhang <yiwzhang@google.com> Tested-by: Yiwei Zhang <yiwzhang@google.com> Reviewed-by: Jonathan Fan <jonfan@chromium.org>
This directory contains public ChromiumOS project documentation that is automatically rendered by Gitiles. The docs are written in Gitiles-flavored Markdown.
See the Chromium documentation guidelines and Chromium documentation best practices.
Markdown documents must follow the style guide.
This repository is managed by the repo tool, so you can make changes to it using the same techniques that you'd use for any other repositories in the project.
See the Contributing guide for more details.
You can preview your local changes using scripts/preview_docs which utilizes Gerrit sandbox branches:
scripts/preview_docs README.md
You can also use md_browser, which is entirely local and does not require refs/sandbox/ push permission, but has somewhat inaccurate rendering:
# at top of ChromiumOS checkout ./src/chromium/src/tools/md_browser/md_browser.py -d docs
Then browse to e.g. http://localhost:8080/README.md.
To review someone else's changes, apply them locally first, or just click the gitiles link near the top of a Gerrit file diff page.