mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2024-11-25 13:23:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
crosvm/docs/book/book.toml

23 lines
517 B
TOML
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
[book]
Fix remaining Chrome/Chromium OS instances These should be written as ChromeOS and ChromiumOS (without the space) to match the updated branding. The copyright headers were already migrated to the new style (https://crrev.com/c/3894243), but there were some more instances left over. BUG=None TEST=tools/cargo-doc Change-Id: I8c76aea2eb33b2e370ab71ee9b5cc0a4cfd00585 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4129934 Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
2022-12-29 21:24:33 +00:00
authors = ["The ChromiumOS Authors"]
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
language = "en"
multilingual = false
src = "src"
title = "Book of crosvm"
book: add mermaid-js support TEST=mdbook docs/book BUG=None Change-Id: I63c487e3718ed47f7084b211fa398422b8b571fa Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2991090 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-25 20:15:55 +00:00
[preprocessor]
[preprocessor.mermaid]
command = "mdbook-mermaid"
[output]
[output.html]
additional-js = ["mermaid.min.js", "mermaid-init.js"]
docs: Enable mdbook-linkcheck Use https://github.com/Michael-F-Bryan/mdbook-linkcheck to check broken links. Since this is added as a target in book.toml, the check will run while `mdbook build`. BUG=none TEST=Run `mdbook build` Change-Id: I7615953f9428c2f8a7a4ec456bb6ae92ede55c68 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3423291 Reviewed-by: Dennis Kempin <denniskempin@google.com> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2022-02-02 00:52:18 +00:00
Add documentation for ChromeOS workflows This change consolidates some of the spread out information about what ChromeOS developers need to know about crosvms differences to other ChromeOS projects. I created a new directory since I would expect a similar guide for AOSP eventually. This also adds more documentation on some of the process changes suggested in go/crosvm-merge-improvements to improve the stability of the merge process. BUG=b:227475914 TEST=None Change-Id: I08111ecd5a937fde22c7d97f342c1cf02f49b02e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3561886 Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com>
2022-03-30 22:38:51 +00:00
# Redirect previously used paths to updated locations.
[output.html.redirect]
"building_crosvm/chromiumos.html" = "../integration/chromeos.html"
Document interrupts & snapshotting. BUG=b:277651566 TEST=ran mdbook serve & verified the book looked as expected. Change-Id: Id6e1723f99dbe428c009a7a03bc651c9b1ee4125 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4598283 Commit-Queue: Noah Gold <nkgold@google.com> Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Reviewed-by: Takaya Saeki <takayas@chromium.org> Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
2023-06-07 22:21:26 +00:00
"architecture.html" = "architecture/overview.html"
docs: book: move testing docs into a directory This will allow us to add more testing-related pages under book/testing/ The previous URL is configured for redirection so existing links should still work. BUG=None TEST=(cd docs/book; mdbook build) Change-Id: I1fe8d8f074791a3a5680581a205f33857c24f6b2 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4669510 Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
2023-07-06 17:47:48 +00:00
"testing.html" = "testing/index.html"
Add documentation for ChromeOS workflows This change consolidates some of the spread out information about what ChromeOS developers need to know about crosvms differences to other ChromeOS projects. I created a new directory since I would expect a similar guide for AOSP eventually. This also adds more documentation on some of the process changes suggested in go/crosvm-merge-improvements to improve the stability of the merge process. BUG=b:227475914 TEST=None Change-Id: I08111ecd5a937fde22c7d97f342c1cf02f49b02e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3561886 Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com>
2022-03-30 22:38:51 +00:00
docs: Enable mdbook-linkcheck Use https://github.com/Michael-F-Bryan/mdbook-linkcheck to check broken links. Since this is added as a target in book.toml, the check will run while `mdbook build`. BUG=none TEST=Run `mdbook build` Change-Id: I7615953f9428c2f8a7a4ec456bb6ae92ede55c68 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3423291 Reviewed-by: Dennis Kempin <denniskempin@google.com> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2022-02-02 00:52:18 +00:00
[output.linkcheck]
Reference in a new issue Copy permalink