Google Git
Sign in
chromium / chromiumos / docs / factory-nocturne-11066.B
commitea286876339a2519ecd818584f18b509ffa04979[log] [tgz]
authorMike Frysinger <vapier@chromium.org>Wed Sep 12 22:36:16 2018
committerchrome-bot <chrome-bot@chromium.org>Thu Sep 13 00:09:35 2018
treef8e852debd8f122a12ad3f9c2b811eba07a3d295
parente685f11fd4c22fe0fcecb4084873cdbbdf55209d [diff]
containers_and_vms: fix supported now link

Change-Id: I4484538f971a309a17be8e845308db059ac8bf34
Reviewed-on: https://chromium-review.googlesource.com/1222926
Commit-Ready: Mike Frysinger <vapier@chromium.org>
Tested-by: Mike Frysinger <vapier@chromium.org>
Reviewed-by: Stephen Barber <smbarber@chromium.org>
1 file changed
tree: f8e852debd8f122a12ad3f9c2b811eba07a3d295
  1. images/
  2. scripts/
  3. ca_certs.md
  4. chrome_commit_pipeline.md
  5. COMMIT-QUEUE.ini
  6. containers_and_vms.md
  7. cros_commit_pipeline.md
  8. cros_vm.md
  9. dbus_best_practices.md
  10. dbus_in_chrome.md
  11. developer_guide.md
  12. development_basics.md
  13. fuzzing.md
  14. kernel_faq.md
  15. navbar.md
  16. platform2_gn.md
  17. PRESUBMIT.cfg
  18. README.md
  19. reporting_bugs.md
  20. rust_on_cros.md
  21. sandboxing.md
  22. security_review_howto.md
  23. security_severity_guidelines.md
  24. simple_chrome_workflow.md
  25. unit_tests.md
README.md

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 scripts/preview_docs:

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 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.