tree: 80971be7dc4a4b98bfe5ff82633b93787dbc6b0d [path history] [tgz]
  1. COMMIT-QUEUE.ini
  2. PRESUBMIT.cfg
  3. README.md
  4. archive_mirrors.md
  5. ca_certs.md
  6. chrome_commit_pipeline.md
  7. contact.md
  8. containers_and_vms.md
  9. contributing.md
  10. cros_commit_pipeline.md
  11. cros_config_tast_test.md
  12. cros_vm.md
  13. dbus_best_practices.md
  14. dbus_in_chrome.md
  15. debug_buttons.md
  16. developer_guide.md
  17. development_basics.md
  18. eol_aue_process.md
  19. fuzzing.md
  20. gsutil.md
  21. images/
  22. kernel_faq.md
  23. lsb-release.md
  24. navbar.md
  25. os_config.md
  26. platform2_gn.md
  27. reporting_bugs.md
  28. rust_on_cros.md
  29. sandboxing.md
  30. scripts/
  31. security_review_howto.md
  32. security_severity_guidelines.md
  33. security_sheriffing.md
  34. simple_chrome_workflow.md
  35. source_layout.md
  36. 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.

See the Contributing guide for more details.

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.