mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2025-02-11 20:56:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
crosvm/docs/book/src/SUMMARY.md

28 lines
1.1 KiB
Markdown
Raw Normal View History

book: add initial book using mdbook This change adds a document that was already written, but never published before. Also, the summary includes a skeleton of chapters to be filled in by future changes. TEST=mdbook build docs/book BUG=None Change-Id: If1d6e295b6d5a639f728f5de0df73de094399166 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2982861 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-06-23 18:05:57 +00:00
# Summary
docs: Run mdformat Ran: $ find ./docs/book/src/ -name "*.md" | xargs mdformat --in_place BUG=none TEST=mdbook build Change-Id: I56c74538a4c2643fa2c6e33fe99660611442b4dc Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188672 Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-27 08:54:23 +00:00
- [Introduction](./introduction.md)
- [Building Crosvm](./building_crosvm/index.md)
- [For Linux](./building_crosvm/linux.md)
- [For Chromium OS](./building_crosvm/chromium_os.md)
- [Running Crosvm](./running_crosvm/index.md)
Reorganize usage doc and add example usage BUG=b:214104901 TEST=mdbook serve Change-Id: I7039493212912cb698f74967abef228df278f4c7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3399872 Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-21 19:07:58 +00:00
- [Example Usage](./running_crosvm/example_usage.md)
- [Advanced Usage](./running_crosvm/advanced_usage.md)
- [Custom Kernel / Rootfs](./running_crosvm/custom_kernel_rootfs.md)
docs: Run mdformat Ran: $ find ./docs/book/src/ -name "*.md" | xargs mdformat --in_place BUG=none TEST=mdbook build Change-Id: I56c74538a4c2643fa2c6e33fe99660611442b4dc Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188672 Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-27 08:54:23 +00:00
- [System Requirements](./running_crosvm/requirements.md)
- [Features](./running_crosvm/features.md)
- [Devices](./running_crosvm/devices.md)
docs: Add ARCHITECTURE.md It's a common idea to have ARCHITECTURE.md next to README.md and CONTRIBUTING.md [1]. So, let's do so instead of having the doc only under mdbook. [1] https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html BUG=b:195003973 TEST=mdbook build Change-Id: I8d3f479ba65c7f85865c51b5c22fb5b37d6e8f78 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188675 Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Chirantan Ekbote <chirantan@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-21 15:11:54 +00:00
- [Architecture](./architecture.md)
docs: Run mdformat Ran: $ find ./docs/book/src/ -name "*.md" | xargs mdformat --in_place BUG=none TEST=mdbook build Change-Id: I56c74538a4c2643fa2c6e33fe99660611442b4dc Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188672 Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-27 08:54:23 +00:00
- [Contributing](./contributing.md)
book: add initial book using mdbook This change adds a document that was already written, but never published before. Also, the summary includes a skeleton of chapters to be filled in by future changes. TEST=mdbook build docs/book BUG=None Change-Id: If1d6e295b6d5a639f728f5de0df73de094399166 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2982861 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-06-23 18:05:57 +00:00
docs: Run mdformat Ran: $ find ./docs/book/src/ -name "*.md" | xargs mdformat --in_place BUG=none TEST=mdbook build Change-Id: I56c74538a4c2643fa2c6e33fe99660611442b4dc Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188672 Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-27 08:54:23 +00:00
--------------------------------------------------------------------------------
book: add initial book using mdbook This change adds a document that was already written, but never published before. Also, the summary includes a skeleton of chapters to be filled in by future changes. TEST=mdbook build docs/book BUG=None Change-Id: If1d6e295b6d5a639f728f5de0df73de094399166 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2982861 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-06-23 18:05:57 +00:00
Add onboarding resources to mdbook This is converted from our onboarding doc with internal references removed. BUG=b:199926026 TEST=None Change-Id: Ibb94e194583b12c1ec7fe3d80306156e34e50000 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3229948 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-10-18 21:09:24 +00:00
- [Onboarding Resources](./onboarding.md)
docs: Run mdformat Ran: $ find ./docs/book/src/ -name "*.md" | xargs mdformat --in_place BUG=none TEST=mdbook build Change-Id: I56c74538a4c2643fa2c6e33fe99660611442b4dc Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188672 Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-27 08:54:23 +00:00
- [Appendix](./appendix/index.md)
- [Sandboxing](./appendix/sandboxing.md)
- [Seccomp](./appendix/seccomp.md)
- [Minijail](./appendix/minijail.md)
mdbook: Generate cargo-doc by GitHub Actions BUG=b:199874828 TEST=run in my GitHub account Change-Id: Ie456a90731ccedc4934a13110902ea153fce23ae Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3159891 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-08-24 09:58:07 +00:00
--------------------------------------------------------------------------------
[API Documentation](./api.md)
Reference in a new issue Copy permalink