Google Git
Sign in
chromium / chromiumos / docs / 9fc0fc0
commit9fc0fc0da9d0a3cf64b65ef9854f17f7ca95ddb1[log] [tgz]
authorMike Frysinger <[email protected]>Sat Sep 05 05:18:57 2020
committerCommit Bot <[email protected]>Thu Sep 10 02:20:56 2020
treedae07934e529f3e9269c47a3dce18aae81df0a7b
parenta1c861055423bae941beee752e549b77ccdb3a60 [diff]
update & refresh links

* Replace "master" with "HEAD".
* Use https:// in a lot of places.
* Use crbug.com as a shortcut.
* Update some dead links.
* Drop the chromiumos/docs/ prefix on a lot of files.

Change-Id: I9ef52e8b4e3c8c86678edf7a92c0b368874cfd0d
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/2393474
Reviewed-by: Bernie Thompson <[email protected]>
Commit-Queue: Mike Frysinger <[email protected]>
Tested-by: Mike Frysinger <[email protected]>
56 files changed
tree: dae07934e529f3e9269c47a3dce18aae81df0a7b
  1. constants/
  2. design_docs/
  3. firmware/
  4. images/
  5. packages/
  6. portage/
  7. scripts/
  8. security/
  9. styleguide/
  10. testing/
  11. .gitignore
  12. adding_builder_variants.md
  13. archive_mirrors.md
  14. ca_certs.md
  15. chrome_commit_pipeline.md
  16. chromeos_gn.md
  17. contact.md
  18. containers_and_vms.md
  19. contributing.md
  20. cros_commit_pipeline.md
  21. cros_flash.md
  22. cros_tools.md
  23. cros_vm.md
  24. crostini_developer_guide.md
  25. dbus_best_practices.md
  26. dbus_in_chrome.md
  27. debug_buttons.md
  28. developer_guide.md
  29. developer_mode.md
  30. development_basics.md
  31. eol_aue_process.md
  32. firmware_code_reviews.md
  33. firmware_test_manual.md
  34. git_and_gerrit_intro.md
  35. glossary.md
  36. gsutil.md
  37. input_stack.md
  38. kernel_development.md
  39. kernel_faq.md
  40. kernel_tips_and_tricks.md
  41. logging.md
  42. lsb-release.md
  43. navbar.md
  44. os_config.md
  45. OWNERS
  46. pd_firmware_update.md
  47. platform2_primer.md
  48. PRESUBMIT.cfg
  49. programming_languages.md
  50. README.md
  51. remote_trybots.md
  52. repo-tool.md
  53. reporting_bugs.md
  54. rust_on_cros.md
  55. sandboxing.md
  56. security_review_howto.md
  57. security_severity_guidelines.md
  58. sheriff_faq.md
  59. simple_chrome_workflow.md
  60. source_layout.md
  61. stack_traces.md
  62. test_install_configuration.md
  63. tips-and-tricks.md
  64. work_on_branch.md
  65. write_protection.md
  66. xbuddy.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
cd docs
curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg
chmod +x .git/hooks/commit-msg
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.