Google Git
Sign in
chromium / chromiumos / docs / 631ad338db048ba61c31ff56458e092dd092d604
commit631ad338db048ba61c31ff56458e092dd092d604[log] [tgz]
authorKalvin Lee <kdlee@chromium.org>Wed May 15 16:42:34 2019
committerchrome-bot <chrome-bot@chromium.org>Tue May 21 20:28:18 2019
tree480f45940bf192b35eeb102b97e4584b455c076a
parent3d7cbff0be260fd212a73dfaf1f5c63c79512d91 [diff]
docs: add "Getting started with platform2" guide

This markdown document was migrated from the Chromium site:
https://www.chromium.org/chromium-os/getting-started-with-platform2
and aims to replace the same.

BUG=chromium:813194
TEST=N/A

Change-Id: I76d4861a4f0c862c13baee1056d3d4d1805e9d5a
Reviewed-on: https://chromium-review.googlesource.com/1611031
Commit-Ready: Jorge Lucangeli Obes <jorgelo@chromium.org>
Tested-by: Kalvin Lee <kdlee@chromium.org>
Legacy-Commit-Queue: Commit Bot <commit-bot@chromium.org>
Reviewed-by: Jorge Lucangeli Obes <jorgelo@chromium.org>
1 file changed
tree: 480f45940bf192b35eeb102b97e4584b455c076a
  1. images/
  2. portage/
  3. scripts/
  4. security/
  5. archive_mirrors.md
  6. ca_certs.md
  7. chrome_commit_pipeline.md
  8. COMMIT-QUEUE.ini
  9. contact.md
  10. containers_and_vms.md
  11. contributing.md
  12. cros_commit_pipeline.md
  13. cros_flash.md
  14. cros_vm.md
  15. dbus_best_practices.md
  16. dbus_in_chrome.md
  17. debug_buttons.md
  18. developer_guide.md
  19. development_basics.md
  20. eol_aue_process.md
  21. fuzzing.md
  22. glossary.md
  23. gsutil.md
  24. kernel_faq.md
  25. lsb-release.md
  26. navbar.md
  27. os_config.md
  28. OWNERS
  29. platform2_gn.md
  30. platform2_primer.md
  31. PRESUBMIT.cfg
  32. README.md
  33. reporting_bugs.md
  34. rust_on_cros.md
  35. sandboxing.md
  36. security_review_howto.md
  37. security_severity_guidelines.md
  38. security_sheriffing.md
  39. selinux.md
  40. simple_chrome_workflow.md
  41. source_layout.md
  42. 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 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 Chromium OS 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.