commit | 385208204ecdf504ea41edee1c4cd606a5e3efe0 | [log] [tgz] |
---|---|---|
author | Satoru Takabayashi <satorux@google.com> | Wed Jun 28 05:01:07 2017 |
committer | Satoru Takabayashi <satorux@google.com> | Wed Jun 28 05:38:09 2017 |
tree | 741c6e7c4cc4325dfaf76a9e0557eee6cf204068 | |
parent | 1bce940adaf7396ac8d6c17d23df69d930a6bb1a [diff] |
docs: Describe how to make changes without repo Update README.md to briefly mention how to make documentation changes without 'repo' tool. BUG=none TEST=created this patch per the described instructions. :) Change-Id: I4fbcbc8f8ae57d61ebcb42abce86005572f38ec8
This directory contains public Chromium OS 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. Feel free to bypass the commit queue and commit changes immediately after they are reviewed.
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.
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.