From 6e1a8cf5e5e8bdcaee72feb6371a4f2aa17db8b6 Mon Sep 17 00:00:00 2001 From: Tanjil Date: Sun, 3 Nov 2024 12:38:55 +0000 Subject: [PATCH] docs: update github pages links (#2969) * Update Cargo.toml * Update Cargo.toml * Update Cargo.toml * Update Cargo.toml * Update documentation_mdbook.md * Update Cargo.toml * Update Cargo.toml * Update README.md * Update README.md * Update README.md Co-authored-by: Paul "TBBle" Hampson * Update README.md Co-authored-by: Paul "TBBle" Hampson * Update README.md Co-authored-by: Paul "TBBle" Hampson * Update docs/src/developer/documentation_mdbook.md Co-authored-by: Paul "TBBle" Hampson * Update tools/wasm-sample/README.md Co-authored-by: Paul "TBBle" Hampson --------- Co-authored-by: Paul "TBBle" Hampson --- README.md | 6 +++--- crates/libcgroups/Cargo.toml | 2 +- crates/libcontainer/Cargo.toml | 2 +- crates/liboci-cli/Cargo.toml | 2 +- crates/youki/Cargo.toml | 2 +- docs/src/developer/documentation_mdbook.md | 2 +- experiment/seccomp/Cargo.toml | 2 +- experiment/selinux/Cargo.toml | 2 +- tools/wasm-sample/README.md | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1098c489..4d1329ea 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ youki is named after the Japanese word 'youki', which means 'a container'. In Ja > $ sudo podman run --cgroup-manager=cgroupfs --runtime /workspaces/youki/youki hello-world > ``` -[User Documentation](https://containers.github.io/youki/user/basic_setup.html#quick-install) +[User Documentation](https://youki-dev.github.io/youki/user/basic_setup.html#quick-install) # 🎯 Motivation @@ -96,7 +96,7 @@ We have [our roadmap](https://github.com/orgs/containers/projects/15). # 🎨 Design and implementation of youki -The User and Developer Documentation for youki is hosted at [https://containers.github.io/youki/](https://containers.github.io/youki/) +The User and Developer Documentation for youki is hosted at [https://youki-dev.github.io/youki/](https://youki-dev.github.io/youki/) ![Architecture](docs/.drawio.svg) @@ -277,7 +277,7 @@ just youki-dev # or youki-release # 👥 Community and Contributing -Please refer to [our community page](https://containers.github.io/youki/community/introduction.html). +Please refer to [our community page](https://youki-dev.github.io/youki/community/introduction.html). Thanks to all the people who already contributed! diff --git a/crates/libcgroups/Cargo.toml b/crates/libcgroups/Cargo.toml index a9cad30c..3bf99dd3 100644 --- a/crates/libcgroups/Cargo.toml +++ b/crates/libcgroups/Cargo.toml @@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version description = "Library for cgroup" license-file = "../../LICENSE" repository = "https://github.com/containers/youki" -homepage = "https://containers.github.io/youki" +homepage = "https://youki-dev.github.io/youki/" readme = "README.md" authors = ["youki team"] edition = "2021" diff --git a/crates/libcontainer/Cargo.toml b/crates/libcontainer/Cargo.toml index 7f571139..950e00ca 100644 --- a/crates/libcontainer/Cargo.toml +++ b/crates/libcontainer/Cargo.toml @@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version description = "Library for container control" license-file = "../../LICENSE" repository = "https://github.com/containers/youki" -homepage = "https://containers.github.io/youki" +homepage = "https://youki-dev.github.io/youki/" readme = "README.md" authors = ["youki team"] edition = "2021" diff --git a/crates/liboci-cli/Cargo.toml b/crates/liboci-cli/Cargo.toml index 99fcb8c9..9835a45b 100644 --- a/crates/liboci-cli/Cargo.toml +++ b/crates/liboci-cli/Cargo.toml @@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version description = "Parse command line arguments for OCI container runtimes" license-file = "../../LICENSE" repository = "https://github.com/containers/youki" -homepage = "https://containers.github.io/youki" +homepage = "https://youki-dev.github.io/youki/" readme = "README.md" authors = ["youki team"] edition = "2021" diff --git a/crates/youki/Cargo.toml b/crates/youki/Cargo.toml index f3dbcf26..411a46fd 100644 --- a/crates/youki/Cargo.toml +++ b/crates/youki/Cargo.toml @@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version description = "A container runtime written in Rust" license-file = "../../LICENSE" repository = "https://github.com/containers/youki" -homepage = "https://containers.github.io/youki" +homepage = "https://youki-dev.github.io/youki/" readme = "../../README.md" authors = ["youki team"] edition = "2021" diff --git a/docs/src/developer/documentation_mdbook.md b/docs/src/developer/documentation_mdbook.md index 65b2d350..fc76e304 100644 --- a/docs/src/developer/documentation_mdbook.md +++ b/docs/src/developer/documentation_mdbook.md @@ -4,7 +4,7 @@ This documentation is created using mdbook and aims to provide a concise referen Please make sure that you update this documentation along with newly added features and resources that you found helpful while developing, so that it will be helpful for newcomers. -Currently this documentation is hosted at [https://containers.github.io/youki/](https://containers.github.io/youki/), using GitHub pages. GitHub CI actions are used to automatically check if any files are changed in /docs on each push / PR merge to main branch, and if there are any changes, the mdbook is build and deployed to gh-pages. We use [https://github.com/peaceiris/actions-mdbook](https://github.com/peaceiris/actions-mdbook) to build and then [https://github.com/peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) GitHub action to deploy the mdbook. +Currently this documentation is hosted at [https://youki-dev.github.io/youki/](https://youki-dev.github.io/youki/), using GitHub pages. GitHub CI actions are used to automatically check if any files are changed in /docs on each push / PR merge to main branch, and if there are any changes, the mdbook is build and deployed to gh-pages. We use [https://github.com/peaceiris/actions-mdbook](https://github.com/peaceiris/actions-mdbook) to build and then [https://github.com/peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) GitHub action to deploy the mdbook. When testing locally you can manually test the changes by running `mdbook serve` in the docs directory (after installing mdbook), which will temporarily serve the mdbook at `localhost:3000` by default. You can check the mdbook documentation for more information. diff --git a/experiment/seccomp/Cargo.toml b/experiment/seccomp/Cargo.toml index 0b5bbc8e..dd44c72c 100644 --- a/experiment/seccomp/Cargo.toml +++ b/experiment/seccomp/Cargo.toml @@ -4,7 +4,7 @@ version = "0.0.0" description = "Library for seccomp" license-file = "../../LICENSE" repository = "https://github.com/containers/youki" -homepage = "https://containers.github.io/youki" +homepage = "https://youki-dev.github.io/youki/" readme = "README.md" authors = ["youki team"] edition = "2021" diff --git a/experiment/selinux/Cargo.toml b/experiment/selinux/Cargo.toml index 35107f76..d02d4a6b 100644 --- a/experiment/selinux/Cargo.toml +++ b/experiment/selinux/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" description = "Library for selinux" license-file = "../../LICENSE" repository = "https://github.com/containers/youki" -homepage = "https://containers.github.io/youki" +homepage = "https://youki-dev.github.io/youki/" readme = "README.md" authors = ["youki team"] edition = "2021" diff --git a/tools/wasm-sample/README.md b/tools/wasm-sample/README.md index 3485ef03..1800471d 100644 --- a/tools/wasm-sample/README.md +++ b/tools/wasm-sample/README.md @@ -4,7 +4,7 @@ This is a simple wasm module for testing purposes. It prints out the arguments g cargo build --target wasm32-wasi ``` -If you want youki to execute the module you must copy it to the root file system of the container and reference it in the args of the config.json. You must also ensure that the annotations contain `"run.oci.handler": "wasm"` and that youki has been compiled with one of the supported wasm runtimes. For further information please check the [documentation](https://containers.github.io/youki/user/webassembly.html). +If you want youki to execute the module you must copy it to the root file system of the container and reference it in the args of the config.json. You must also ensure that the annotations contain `"run.oci.handler": "wasm"` and that youki has been compiled with one of the supported wasm runtimes. For further information please check the [documentation](https://youki-dev.github.io/youki/user/webassembly.html). ``` "ociVersion": "1.0.2-dev",