Factory: Usage Guides in source repository as Markdown |
||||||
Issue descriptionCurrently we have migrated the README files in factory repo into README.md, but we didn't explicitly specify what should be contained in README.md. To help external developers understand how the factory software works, we should publish how-to and usage guides in a better way. A proposal is to make sure usage guide for all major components (i.e., instalog, dome, goofy, init, test_list, ... etc) are available in the source tree, as Markdown documents. This would help external developers to easily access the documents (for example, https://chromium.googlesource.com/chromiumos/platform/factory/+/master/README.md ) without worrying about if the given docs (from partner-site, or some pdf) is out-dated, also helps us to prevent maintaining lots of legacy usage guides.
,
Oct 28 2016
Created https://b.corp.google.com/issues/32493714 for Instalog.
,
Nov 14 2016
The following revision refers to this bug: https://chromium.googlesource.com/chromiumos/platform/factory/+/a5e91f0cc8373522922f34449634afb0f4cf703d commit a5e91f0cc8373522922f34449634afb0f4cf703d Author: Mao Huang <littlecvr@chromium.org> Date: Mon Nov 14 07:05:25 2016 vswr: add README.md BUG= chromium:658752 TEST=None Change-Id: I98ea6d0d77cd3dd93c43f4183daa1baca54afe1d Reviewed-on: https://chromium-review.googlesource.com/410922 Commit-Ready: Mao Huang <littlecvr@chromium.org> Tested-by: Mao Huang <littlecvr@chromium.org> Reviewed-by: Hung-Te Lin <hungte@chromium.org> [add] https://crrev.com/a5e91f0cc8373522922f34449634afb0f4cf703d/py/test/pytests/vswr/README.md
,
Dec 1 2016
The following revision refers to this bug: https://chromium.googlesource.com/chromiumos/platform/factory/+/82f73348ef1412315f8800848a829b4ad6073f4b commit 82f73348ef1412315f8800848a829b4ad6073f4b Author: Hung-Te Lin <hungte@chromium.org> Date: Thu Dec 01 07:51:50 2016 README.md: Add more complete factory software intro. Merged information from http://dev.chromium.org/chromium-os/how-tos-and-troubleshooting/building-factory-test-images BUG= chromium:658752 TEST=none Change-Id: Iefa1e21ce2ae7716452e686c971a662a1057e33e Reviewed-on: https://chromium-review.googlesource.com/415768 Commit-Ready: Hung-Te Lin <hungte@chromium.org> Tested-by: Hung-Te Lin <hungte@chromium.org> Reviewed-by: Wei-Han Chen <stimim@chromium.org> [modify] https://crrev.com/82f73348ef1412315f8800848a829b4ad6073f4b/README.md
,
Dec 1 2016
The following revision refers to this bug: https://chromium.googlesource.com/chromiumos/platform/factory/+/82f73348ef1412315f8800848a829b4ad6073f4b commit 82f73348ef1412315f8800848a829b4ad6073f4b Author: Hung-Te Lin <hungte@chromium.org> Date: Thu Dec 01 07:51:50 2016 README.md: Add more complete factory software intro. Merged information from http://dev.chromium.org/chromium-os/how-tos-and-troubleshooting/building-factory-test-images BUG= chromium:658752 TEST=none Change-Id: Iefa1e21ce2ae7716452e686c971a662a1057e33e Reviewed-on: https://chromium-review.googlesource.com/415768 Commit-Ready: Hung-Te Lin <hungte@chromium.org> Tested-by: Hung-Te Lin <hungte@chromium.org> Reviewed-by: Wei-Han Chen <stimim@chromium.org> [modify] https://crrev.com/82f73348ef1412315f8800848a829b4ad6073f4b/README.md
,
Jan 25 2017
We've migrated few important ones. Close as fixed.
,
Apr 17 2017
,
May 30 2017
,
Jun 8 2017
The following revision refers to this bug: https://chromium.googlesource.com/chromiumos/platform/factory/+/a9a17baf242461dec7a8965e6480eba59d64d52b commit a9a17baf242461dec7a8965e6480eba59d64d52b Author: Wei-Han Chen <stimim@google.com> Date: Thu Jun 08 06:45:50 2017 factory: add netboot setup guide BUG= chromium:658752 TEST=None Change-Id: I91d25dd594865e01a079e98c6ad18f6306af1c14 Reviewed-on: https://chromium-review.googlesource.com/515184 Commit-Ready: Wei-Han Chen <stimim@chromium.org> Tested-by: Wei-Han Chen <stimim@chromium.org> Reviewed-by: Hung-Te Lin <hungte@chromium.org> [add] https://crrev.com/a9a17baf242461dec7a8965e6480eba59d64d52b/setup/NETBOOT.md [modify] https://crrev.com/a9a17baf242461dec7a8965e6480eba59d64d52b/README.md
,
Jul 7 2017
The following revision refers to this bug: https://chromium.googlesource.com/chromiumos/platform/factory/+/580f3a7a2e05bd5602838b39591a28e55845c36a commit 580f3a7a2e05bd5602838b39591a28e55845c36a Author: Hung-Te Lin <hungte@chromium.org> Date: Fri Jul 07 09:40:04 2017 README: Provide more links and clean up. Make top level clean (with a single README.md) and provide more links so most important README.md files are referenced in the top level file. BUG= chromium:658752 TEST=None Change-Id: I4a463d9db53d0ffd3adda64c9769b6a305d6d7e8 Reviewed-on: https://chromium-review.googlesource.com/562908 Commit-Ready: Hung-Te Lin <hungte@chromium.org> Tested-by: Hung-Te Lin <hungte@chromium.org> Reviewed-by: Youcheng Syu <youcheng@chromium.org> [rename] https://crrev.com/580f3a7a2e05bd5602838b39591a28e55845c36a/setup/BUNDLE.md [add] https://crrev.com/580f3a7a2e05bd5602838b39591a28e55845c36a/devtools/README.md [modify] https://crrev.com/580f3a7a2e05bd5602838b39591a28e55845c36a/README.md
,
Aug 1 2017
,
Oct 14 2017
|
||||||
►
Sign in to add a comment |
||||||
Comment 1 by bugdroid1@chromium.org
, Oct 27 2016