diff --git a/.github/workflows/publish_website.yml b/.github/workflows/publish_website.yml index 9cfa2d0db..26b9bda97 100644 --- a/.github/workflows/publish_website.yml +++ b/.github/workflows/publish_website.yml @@ -4,13 +4,13 @@ on: workflow_dispatch: pull_request: paths: - - docs/** + - book/** - .github/workflows/update-website.yml push: branches: - main paths: - - docs/** + - book/** - .github/workflows/update-website.yml jobs: @@ -26,7 +26,7 @@ jobs: - name: Build the website run: | - cd asterinas/docs + cd asterinas/book mdbook build - name: Deploy website @@ -45,7 +45,7 @@ jobs: cd temp_book git checkout --orphan newBranch git rm -rf * - cp -r ../asterinas/docs/book/* ./ + cp -r ../asterinas/book/book/* ./ git add -A git commit -am "Update website" git branch -D main diff --git a/Makefile b/Makefile index ae277498a..c1507bcd2 100644 --- a/Makefile +++ b/Makefile @@ -305,8 +305,10 @@ docs: $(CARGO_OSDK) @for dir in $(OSDK_CRATES); do \ (cd $$dir && cargo osdk doc --no-deps) || exit 1; \ done - @echo "" # Add a blank line - @cd docs && mdbook build # Build mdBook + +.PHONY: book +book: + @cd book && mdbook build .PHONY: format format: @@ -362,8 +364,8 @@ clean: @cargo clean @echo "Cleaning up OSDK workspace target files" @cd osdk && cargo clean - @echo "Cleaning up documentation target files" - @cd docs && mdbook clean + @echo "Cleaning up mdBook output files" + @cd book && mdbook clean @echo "Cleaning up test target files" @$(MAKE) --no-print-directory -C test clean @echo "Uninstalling OSDK" diff --git a/README.md b/README.md index 7109926fe..aa5d08548 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- asterinas-logo
+ asterinas-logo
A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux
Test x86-64 Test riscv64 diff --git a/README_CN.md b/README_CN.md index 7bbde9abb..77baab18d 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,5 +1,5 @@

- asterinas-logo
+ asterinas-logo
一个安全、快速、通用的操作系统内核，使用Rust编写，并与Linux兼容
Test x86-64 Test riscv64 diff --git a/README_JP.md b/README_JP.md index a559ac9f2..ce12200e4 100644 --- a/README_JP.md +++ b/README_JP.md @@ -1,5 +1,5 @@

- asterinas-logo
+ asterinas-logo
安全で高速、汎用的なOSカーネル。Rustで書かれ、Linuxと互換性があります
Test x86-64 Test riscv64 diff --git a/docs/.gitignore b/book/.gitignore similarity index 100% rename from docs/.gitignore rename to book/.gitignore diff --git a/docs/book.toml b/book/book.toml similarity index 100% rename from docs/book.toml rename to book/book.toml diff --git a/docs/src/README.md b/book/src/README.md similarity index 100% rename from docs/src/README.md rename to book/src/README.md diff --git a/docs/src/SUMMARY.md b/book/src/SUMMARY.md similarity index 100% rename from docs/src/SUMMARY.md rename to book/src/SUMMARY.md diff --git a/docs/src/images/a_comparison_between_os_archs.svg b/book/src/images/a_comparison_between_os_archs.svg similarity index 100% rename from docs/src/images/a_comparison_between_os_archs.svg rename to book/src/images/a_comparison_between_os_archs.svg diff --git a/docs/src/images/four_requirements_for_os_framework.svg b/book/src/images/four_requirements_for_os_framework.svg similarity index 100% rename from docs/src/images/four_requirements_for_os_framework.svg rename to book/src/images/four_requirements_for_os_framework.svg diff --git a/docs/src/images/logo_cn.svg b/book/src/images/logo_cn.svg similarity index 100% rename from docs/src/images/logo_cn.svg rename to book/src/images/logo_cn.svg diff --git a/docs/src/images/logo_en.svg b/book/src/images/logo_en.svg similarity index 100% rename from docs/src/images/logo_en.svg rename to book/src/images/logo_en.svg diff --git a/docs/src/kernel/README.md b/book/src/kernel/README.md similarity index 100% rename from docs/src/kernel/README.md rename to book/src/kernel/README.md diff --git a/docs/src/kernel/advanced-instructions.md b/book/src/kernel/advanced-instructions.md similarity index 100% rename from docs/src/kernel/advanced-instructions.md rename to book/src/kernel/advanced-instructions.md diff --git a/docs/src/kernel/intel_tdx.md b/book/src/kernel/intel_tdx.md similarity index 100% rename from docs/src/kernel/intel_tdx.md rename to book/src/kernel/intel_tdx.md diff --git a/docs/src/kernel/linux-compatibility/README.md b/book/src/kernel/linux-compatibility/README.md similarity index 100% rename from docs/src/kernel/linux-compatibility/README.md rename to book/src/kernel/linux-compatibility/README.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/README.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/README.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/README.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/README.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/file-and-directory-operations.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/file-and-directory-operations.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/file-and-directory-operations.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/file-and-directory-operations.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/file-descriptor-and-io-control.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/file-descriptor-and-io-control.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/file-descriptor-and-io-control.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/file-descriptor-and-io-control.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/file-systems-and-mount-control.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/file-systems-and-mount-control.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/file-systems-and-mount-control.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/file-systems-and-mount-control.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/inter-process-communication.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/inter-process-communication.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/inter-process-communication.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/inter-process-communication.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/memory-management.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/memory-management.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/memory-management.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/memory-management.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/namespaces-cgroups-and-security.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/namespaces-cgroups-and-security.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/namespaces-cgroups-and-security.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/namespaces-cgroups-and-security.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/networking-and-sockets.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/networking-and-sockets.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/networking-and-sockets.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/networking-and-sockets.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/process-and-thread-management.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/process-and-thread-management.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/process-and-thread-management.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/process-and-thread-management.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/signals-and-timers.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/signals-and-timers.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/signals-and-timers.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/signals-and-timers.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/system-call-matching-language.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/system-call-matching-language.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/system-call-matching-language.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/system-call-matching-language.md diff --git a/docs/src/kernel/linux-compatibility/limitations-on-system-calls/system-information-and-misc.md b/book/src/kernel/linux-compatibility/limitations-on-system-calls/system-information-and-misc.md similarity index 100% rename from docs/src/kernel/linux-compatibility/limitations-on-system-calls/system-information-and-misc.md rename to book/src/kernel/linux-compatibility/limitations-on-system-calls/system-information-and-misc.md diff --git a/docs/src/kernel/roadmap.md b/book/src/kernel/roadmap.md similarity index 100% rename from docs/src/kernel/roadmap.md rename to book/src/kernel/roadmap.md diff --git a/docs/src/kernel/the-approach/README.md b/book/src/kernel/the-approach/README.md similarity index 100% rename from docs/src/kernel/the-approach/README.md rename to book/src/kernel/the-approach/README.md diff --git a/docs/src/kernel/the-approach/capabilities.md b/book/src/kernel/the-approach/capabilities.md similarity index 100% rename from docs/src/kernel/the-approach/capabilities.md rename to book/src/kernel/the-approach/capabilities.md diff --git a/docs/src/kernel/the-approach/components.md b/book/src/kernel/the-approach/components.md similarity index 100% rename from docs/src/kernel/the-approach/components.md rename to book/src/kernel/the-approach/components.md diff --git a/docs/src/kernel/the-approach/framekernel.md b/book/src/kernel/the-approach/framekernel.md similarity index 100% rename from docs/src/kernel/the-approach/framekernel.md rename to book/src/kernel/the-approach/framekernel.md diff --git a/docs/src/kernel/the-framekernel-architecture.md b/book/src/kernel/the-framekernel-architecture.md similarity index 100% rename from docs/src/kernel/the-framekernel-architecture.md rename to book/src/kernel/the-framekernel-architecture.md diff --git a/docs/src/osdk/guide/README.md b/book/src/osdk/guide/README.md similarity index 100% rename from docs/src/osdk/guide/README.md rename to book/src/osdk/guide/README.md diff --git a/docs/src/osdk/guide/advanced_topics.md b/book/src/osdk/guide/advanced_topics.md similarity index 100% rename from docs/src/osdk/guide/advanced_topics.md rename to book/src/osdk/guide/advanced_topics.md diff --git a/docs/src/osdk/guide/create-project.md b/book/src/osdk/guide/create-project.md similarity index 100% rename from docs/src/osdk/guide/create-project.md rename to book/src/osdk/guide/create-project.md diff --git a/docs/src/osdk/guide/intel-tdx.md b/book/src/osdk/guide/intel-tdx.md similarity index 100% rename from docs/src/osdk/guide/intel-tdx.md rename to book/src/osdk/guide/intel-tdx.md diff --git a/docs/src/osdk/guide/run-project.md b/book/src/osdk/guide/run-project.md similarity index 100% rename from docs/src/osdk/guide/run-project.md rename to book/src/osdk/guide/run-project.md diff --git a/docs/src/osdk/guide/why.md b/book/src/osdk/guide/why.md similarity index 100% rename from docs/src/osdk/guide/why.md rename to book/src/osdk/guide/why.md diff --git a/docs/src/osdk/guide/work-in-workspace.md b/book/src/osdk/guide/work-in-workspace.md similarity index 100% rename from docs/src/osdk/guide/work-in-workspace.md rename to book/src/osdk/guide/work-in-workspace.md diff --git a/docs/src/osdk/reference/README.md b/book/src/osdk/reference/README.md similarity index 100% rename from docs/src/osdk/reference/README.md rename to book/src/osdk/reference/README.md diff --git a/docs/src/osdk/reference/commands/README.md b/book/src/osdk/reference/commands/README.md similarity index 100% rename from docs/src/osdk/reference/commands/README.md rename to book/src/osdk/reference/commands/README.md diff --git a/docs/src/osdk/reference/commands/build.md b/book/src/osdk/reference/commands/build.md similarity index 100% rename from docs/src/osdk/reference/commands/build.md rename to book/src/osdk/reference/commands/build.md diff --git a/docs/src/osdk/reference/commands/debug.md b/book/src/osdk/reference/commands/debug.md similarity index 100% rename from docs/src/osdk/reference/commands/debug.md rename to book/src/osdk/reference/commands/debug.md diff --git a/docs/src/osdk/reference/commands/new.md b/book/src/osdk/reference/commands/new.md similarity index 100% rename from docs/src/osdk/reference/commands/new.md rename to book/src/osdk/reference/commands/new.md diff --git a/docs/src/osdk/reference/commands/profile.md b/book/src/osdk/reference/commands/profile.md similarity index 100% rename from docs/src/osdk/reference/commands/profile.md rename to book/src/osdk/reference/commands/profile.md diff --git a/docs/src/osdk/reference/commands/run.md b/book/src/osdk/reference/commands/run.md similarity index 100% rename from docs/src/osdk/reference/commands/run.md rename to book/src/osdk/reference/commands/run.md diff --git a/docs/src/osdk/reference/commands/test.md b/book/src/osdk/reference/commands/test.md similarity index 100% rename from docs/src/osdk/reference/commands/test.md rename to book/src/osdk/reference/commands/test.md diff --git a/docs/src/osdk/reference/environment-variables.md b/book/src/osdk/reference/environment-variables.md similarity index 100% rename from docs/src/osdk/reference/environment-variables.md rename to book/src/osdk/reference/environment-variables.md diff --git a/docs/src/osdk/reference/manifest.md b/book/src/osdk/reference/manifest.md similarity index 100% rename from docs/src/osdk/reference/manifest.md rename to book/src/osdk/reference/manifest.md diff --git a/docs/src/ostd/README.md b/book/src/ostd/README.md similarity index 100% rename from docs/src/ostd/README.md rename to book/src/ostd/README.md diff --git a/docs/src/ostd/a-100-line-kernel.md b/book/src/ostd/a-100-line-kernel.md similarity index 100% rename from docs/src/ostd/a-100-line-kernel.md rename to book/src/ostd/a-100-line-kernel.md diff --git a/docs/src/rfcs/0001-rfc-process.md b/book/src/rfcs/0001-rfc-process.md similarity index 100% rename from docs/src/rfcs/0001-rfc-process.md rename to book/src/rfcs/0001-rfc-process.md diff --git a/docs/src/rfcs/0002-osdk.md b/book/src/rfcs/0002-osdk.md similarity index 100% rename from docs/src/rfcs/0002-osdk.md rename to book/src/rfcs/0002-osdk.md diff --git a/docs/src/rfcs/README.md b/book/src/rfcs/README.md similarity index 100% rename from docs/src/rfcs/README.md rename to book/src/rfcs/README.md diff --git a/docs/src/to-contribute/README.md b/book/src/to-contribute/README.md similarity index 100% rename from docs/src/to-contribute/README.md rename to book/src/to-contribute/README.md diff --git a/docs/src/to-contribute/boterinas.md b/book/src/to-contribute/boterinas.md similarity index 100% rename from docs/src/to-contribute/boterinas.md rename to book/src/to-contribute/boterinas.md diff --git a/docs/src/to-contribute/code-of-conduct.md b/book/src/to-contribute/code-of-conduct.md similarity index 100% rename from docs/src/to-contribute/code-of-conduct.md rename to book/src/to-contribute/code-of-conduct.md diff --git a/docs/src/to-contribute/code-organization.md b/book/src/to-contribute/code-organization.md similarity index 100% rename from docs/src/to-contribute/code-organization.md rename to book/src/to-contribute/code-organization.md diff --git a/docs/src/to-contribute/community.md b/book/src/to-contribute/community.md similarity index 100% rename from docs/src/to-contribute/community.md rename to book/src/to-contribute/community.md diff --git a/docs/src/to-contribute/style-guidelines/README.md b/book/src/to-contribute/style-guidelines/README.md similarity index 100% rename from docs/src/to-contribute/style-guidelines/README.md rename to book/src/to-contribute/style-guidelines/README.md diff --git a/docs/src/to-contribute/style-guidelines/general-guidelines.md b/book/src/to-contribute/style-guidelines/general-guidelines.md similarity index 100% rename from docs/src/to-contribute/style-guidelines/general-guidelines.md rename to book/src/to-contribute/style-guidelines/general-guidelines.md diff --git a/docs/src/to-contribute/style-guidelines/git-guidelines.md b/book/src/to-contribute/style-guidelines/git-guidelines.md similarity index 100% rename from docs/src/to-contribute/style-guidelines/git-guidelines.md rename to book/src/to-contribute/style-guidelines/git-guidelines.md diff --git a/docs/src/to-contribute/style-guidelines/rust-guidelines.md b/book/src/to-contribute/style-guidelines/rust-guidelines.md similarity index 100% rename from docs/src/to-contribute/style-guidelines/rust-guidelines.md rename to book/src/to-contribute/style-guidelines/rust-guidelines.md diff --git a/docs/src/to-contribute/version-bump.md b/book/src/to-contribute/version-bump.md similarity index 100% rename from docs/src/to-contribute/version-bump.md rename to book/src/to-contribute/version-bump.md diff --git a/tools/bump_version.sh b/tools/bump_version.sh index 2c3746e37..74fb771f8 100755 --- a/tools/bump_version.sh +++ b/tools/bump_version.sh @@ -123,8 +123,11 @@ update_all_docker_version_refs() { update_image_versions ${ASTER_SRC_DIR}/README_CN.md update_image_versions ${ASTER_SRC_DIR}/README_JP.md update_image_versions ${SCRIPT_DIR}/docker/README.md - update_image_versions ${DOCS_DIR}/src/kernel/intel_tdx.md - update_image_versions ${DOCS_DIR}/src/osdk/guide/intel-tdx.md + + # Update Docker image versions in the Book + update_image_versions ${BOOK_DIR}/src/kernel/README.md + update_image_versions ${BOOK_DIR}/src/kernel/intel_tdx.md + update_image_versions ${BOOK_DIR}/src/osdk/guide/intel-tdx.md # Update Docker image versions in workflows ALL_WORKFLOWS=$(find "${ASTER_SRC_DIR}/.github/workflows/" -type f -name "*.yml") @@ -139,10 +142,6 @@ update_all_docker_version_refs() { update_image_versions "$workflow" fi done - - # Update Docker image versions in the documentation - GET_STARTED_PATH=${ASTER_SRC_DIR}/docs/src/kernel/README.md - update_image_versions $GET_STARTED_PATH } # Update project dependencies (Cargo.toml and Cargo.lock) @@ -214,7 +213,7 @@ update_tag_version() { SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) ASTER_SRC_DIR=${SCRIPT_DIR}/.. -DOCS_DIR=${ASTER_SRC_DIR}/docs +BOOK_DIR=${ASTER_SRC_DIR}/book OSTD_CARGO_TOML_PATH=${ASTER_SRC_DIR}/ostd/Cargo.toml OSTD_TEST_CARGO_TOML_PATH=${ASTER_SRC_DIR}/ostd/libs/ostd-test/Cargo.toml OSTD_MACROS_CARGO_TOML_PATH=${ASTER_SRC_DIR}/ostd/libs/ostd-macros/Cargo.toml