mirror/youki
1
0
Fork 0
mirror of https://github.com/containers/youki synced 2024-11-26 06:08:07 +01:00
Code Issues

docs: update github pages links (#2969)

Browse Source 
* 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 <Paul.Hampson@Pobox.com>

* Update README.md

Co-authored-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>

* Update README.md

Co-authored-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>

* Update docs/src/developer/documentation_mdbook.md

Co-authored-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>

* Update tools/wasm-sample/README.md

Co-authored-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>

---------

Co-authored-by: Paul "TBBle" Hampson <Paul.Hampson@Pobox.com>
This commit is contained in:
Tanjil 2024-11-03 12:38:55 +00:00 committed by GitHub
parent 7e1d5277b1
commit 6e1a8cf5e5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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 > $ 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 # 🎯 Motivation
@ -96,7 +96,7 @@ We have [our roadmap](https://github.com/orgs/containers/projects/15).
# 🎨 Design and implementation of youki # 🎨 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) ![Architecture](docs/.drawio.svg)
@ -277,7 +277,7 @@ just youki-dev # or youki-release
# 👥 Community and Contributing # 👥 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! Thanks to all the people who already contributed!

2
crates/libcgroups/Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version
description = "Library for cgroup" description = "Library for cgroup"
license-file = "../../LICENSE" license-file = "../../LICENSE"
repository = "https://github.com/containers/youki" repository = "https://github.com/containers/youki"
homepage = "https://containers.github.io/youki" homepage = "https://youki-dev.github.io/youki/"
readme = "README.md" readme = "README.md"
authors = ["youki team"] authors = ["youki team"]
edition = "2021" edition = "2021"

2
crates/libcontainer/Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version
description = "Library for container control" description = "Library for container control"
license-file = "../../LICENSE" license-file = "../../LICENSE"
repository = "https://github.com/containers/youki" repository = "https://github.com/containers/youki"
homepage = "https://containers.github.io/youki" homepage = "https://youki-dev.github.io/youki/"
readme = "README.md" readme = "README.md"
authors = ["youki team"] authors = ["youki team"]
edition = "2021" edition = "2021"

2
crates/liboci-cli/Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version
description = "Parse command line arguments for OCI container runtimes" description = "Parse command line arguments for OCI container runtimes"
license-file = "../../LICENSE" license-file = "../../LICENSE"
repository = "https://github.com/containers/youki" repository = "https://github.com/containers/youki"
homepage = "https://containers.github.io/youki" homepage = "https://youki-dev.github.io/youki/"
readme = "README.md" readme = "README.md"
authors = ["youki team"] authors = ["youki team"]
edition = "2021" edition = "2021"

2
crates/youki/Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.4.1" # MARK: Version
description = "A container runtime written in Rust" description = "A container runtime written in Rust"
license-file = "../../LICENSE" license-file = "../../LICENSE"
repository = "https://github.com/containers/youki" repository = "https://github.com/containers/youki"
homepage = "https://containers.github.io/youki" homepage = "https://youki-dev.github.io/youki/"
readme = "../../README.md" readme = "../../README.md"
authors = ["youki team"] authors = ["youki team"]
edition = "2021" edition = "2021"

2
docs/src/developer/documentation_mdbook.md
View File

@ -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. 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. 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.

2
experiment/seccomp/Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.0.0"
description = "Library for seccomp" description = "Library for seccomp"
license-file = "../../LICENSE" license-file = "../../LICENSE"
repository = "https://github.com/containers/youki" repository = "https://github.com/containers/youki"
homepage = "https://containers.github.io/youki" homepage = "https://youki-dev.github.io/youki/"
readme = "README.md" readme = "README.md"
authors = ["youki team"] authors = ["youki team"]
edition = "2021" edition = "2021"

2
experiment/selinux/Cargo.toml
View File

@ -4,7 +4,7 @@ version = "0.1.0"
description = "Library for selinux" description = "Library for selinux"
license-file = "../../LICENSE" license-file = "../../LICENSE"
repository = "https://github.com/containers/youki" repository = "https://github.com/containers/youki"
homepage = "https://containers.github.io/youki" homepage = "https://youki-dev.github.io/youki/"
readme = "README.md" readme = "README.md"
authors = ["youki team"] authors = ["youki team"]
edition = "2021" edition = "2021"

2
tools/wasm-sample/README.md
View File

@ -4,7 +4,7 @@ This is a simple wasm module for testing purposes. It prints out the arguments g
cargo build --target wasm32-wasi 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", "ociVersion": "1.0.2-dev",