部署路径

[zjp-CN]

网址格式：https://os-checker.github.io/docs/{crate_name}

其中 crate_name 是将 package name 中所有 - 替换成 _ 得到的。

示例：https://os-checker.github.io/docs/os_checker_test_suite

cargo doc --document-private-items

docs $ ll repos/os-checker-test-suite/target/doc/
Link# T Permissions User Group      Size Modified            Name
    2 d rwx r-x r-x root root            2024-Nov-02 10:05pm   os_checker_test_suite/
    3 d rwx r-x r-x root root            2024-Nov-02 10:05pm   search.desc/
    3 d rwx r-x r-x root root            2024-Nov-02 10:05pm   src/
    2 d rwx r-x r-x root root            2024-Nov-02 10:05pm   static.files/
    1 f rw- r-- r-- root root   85.0   B 2024-Nov-02 10:05pm    crates.js
    1 f rw- r-- r-- root root    2.9 KiB 2024-Nov-02 10:05pm    help.html
    1 f rw- --- --- root root    0.0   B 2024-Nov-02 10:05pm   .lock
    1 f rw- r-- r-- root root  410.0   B 2024-Nov-02 10:05pm    search-index.js
    1 f rw- r-- r-- root root    2.9 KiB 2024-Nov-02 10:05pm    settings.html
    1 f rw- r-- r-- root root  145.0   B 2024-Nov-02 10:05pm    src-files.js

[zjp-CN]

25e9aeb

cargo doc --document-private-items --workspace

os-checker-test-suite $ ll target/doc/
Link# T Permissions User Group      Size Modified            Name
    2 d rwx r-x r-x root root            2024-Nov-02 10:22pm   lockbud_checks_this/
    2 d rwx r-x r-x root root            2024-Nov-02 10:22pm   mirai_checks_this/
    2 d rwx r-x r-x root root            2024-Nov-02 10:05pm   os_checker_test_suite/
    2 d rwx r-x r-x root root            2024-Nov-02 10:22pm   rap_checks_this/
    6 d rwx r-x r-x root root            2024-Nov-02 10:22pm   rudra_checks_this/
    7 d rwx r-x r-x root root            2024-Nov-02 10:22pm   search.desc/
    7 d rwx r-x r-x root root            2024-Nov-02 10:22pm   src/
    2 d rwx r-x r-x root root            2024-Nov-02 10:05pm   static.files/
    3 d rwx r-x r-x root root            2024-Nov-02 10:22pm   trait.impl/
    1 f rw- r-- r-- root root  177.0   B 2024-Nov-02 10:22pm    crates.js
    1 f rw- r-- r-- root root    2.9 KiB 2024-Nov-02 10:22pm    help.html
    1 f rw- --- --- root root    0.0   B 2024-Nov-02 10:05pm   .lock
    1 f rw- r-- r-- root root    2.1 KiB 2024-Nov-02 10:22pm    search-index.js
    1 f rw- r-- r-- root root    2.9 KiB 2024-Nov-02 10:22pm    settings.html
    1 f rw- r-- r-- root root  383.0   B 2024-Nov-02 10:22pm    src-files.js

https://os-checker.github.io/docs/{os_checker_test_suite,mirai_checks_this,...}

[zjp-CN]

docs/.github/workflows/deploy.yml

Lines 21 to 31 in 9928cdd

	cd repos/os-checker-test-suite
	# cargo doc --document-private-items
	cargo doc --document-private-items --workspace || true
	cd ../os-checker
	cargo doc --document-private-items --workspace || true
	cd ..
	mkdir deploy
	mv os-checker-test-suite/target/doc deploy/os-checker-test-suite
	mv os-checker/target/doc deploy/os-checker

https://os-checker.github.io/docs/os-checker-test-suite/mirai_checks_this

https://os-checker.github.io/docs/os-checker/os_checker

[zjp-CN]

注意：由于每个 target/doc 不含 index.html，直接访问仓库的那个路径，比如 https://os-checker.github.io/docs/os-checker，会出现 404

因此，需要自己做一个引导页面，包含：

• 该仓库的基本信息
• 该仓库内 packages 的基本信息
• 指向 packages 的文档
• 指向 os-checker 的该仓库的链接（将来有的话）

此外，这个访问路径省略了 user，即

• 不是 https://os-checker.github.io/docs/os-checker/os-checker
• 而是 https://os-checker.github.io/docs/os-checker

如果同名的话，这可能带来问题。需要处理同 repo 名的冲突，并在引导页面增加新的跳转？

当然，如果想缩减到 package 维度 https://os-checker.github.io/docs/os_checker，那么就可能存在更多冲突。

---

或者换一种设计，严格采用 /docs/user/repo/pkg 路径，但在 / 页面进行路由控制和重定向，比如

/user/repo/pkg/docs 重定向到 /docs/user/repo/pkg，因为 /user/repo 页面已经是现成的了，而且适合作为引导页面来汇总上面的信息。此外，这种做法只需要改动前端代码，不需要修改 docs 仓库的代码。

与 os-checker/os-checker.github.io#84 相关。

[zjp-CN]

1dd1f76

https://os-checker.github.io/docs/os-checker/os-checker/os_checker