Various Chromium OS docs written in markdown with no other home!

Clone this repo:
  1. ce9f3d6 sandboxing: restore various links by Mike Frysinger · 8 days ago master
  2. 4b52314 allow pre-cq to submit CLs in this repo by Mike Frysinger · 8 days ago
  3. c0b9110 docs: Minor tweaks to reporting_bugs.md. by Daniel Erat · 8 days ago
  4. d9696a6 docs: Add info about crash reports to reporting_bugs.md. by Daniel Erat · 9 days ago
  5. 1048e48 Merge "docs: Add reporting_bugs.md." by Dan Erat · 9 days ago

Chromium OS docs

This directory contains public Chromium OS project documentation that is automatically rendered by Gitiles. The docs are written in Gitiles-flavored Markdown.

General guidelines

See the Chromium documentation guidelines and Chromium documentation best practices.

Style guide

Markdown documents must follow the style guide.

Making changes

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. Feel free to bypass the commit queue and commit changes immediately after they are reviewed.

Making changes without repo

You can also make changes to this repository without using the repo tool. This comes in handy when you don't have a Chromium OS checkout:

git clone https://chromium.googlesource.com/chromiumos/docs
curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg
chmod +x .git/hooks/commit-msg
cd docs
git checkout -b changes
(make some changes)
git commit -a
git push origin HEAD:refs/for/master

The above steps will upload a patch to chromium-review.googlesource.com where you can get your patch reviewed, and submit.

Previewing changes

You can preview your local changes using md_browser:

# at top of Chromium OS checkout
./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.