Google Git
Sign in
chromium / chromiumos / docs / 3e7e0a054a5b79d75fdf541e6c6b115979d0713f
commit3e7e0a054a5b79d75fdf541e6c6b115979d0713f[log] [tgz]
authorNicolas Norvez <norvez@chromium.org>Fri Jun 21 22:48:39 2019
committerchrome-bot <chrome-bot@chromium.org>Sat Jun 22 03:29:58 2019
tree0e8b4c65bd63ca0f3764a75b0f49aa7f63ffffdb
parent63373347f0e4f9567224290003eba50b97cab85b [diff]
contributing: fix outdated link to glossary

The glossary has moved from chromium.org to in-tree Markdown, update the
link.

BUG=None
TEST=preview with gitiles

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