Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update github pages links #2969

Merged
merged 14 commits into from
Nov 3, 2024
Merged

docs: update github pages links #2969

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
fd1083f
Update Cargo.toml
tskxz Oct 30, 2024
762e471
Update Cargo.toml
tskxz Oct 30, 2024
003f33f
Update Cargo.toml
tskxz Oct 30, 2024
3be5be9
Update Cargo.toml
tskxz Oct 30, 2024
cef99c7
Update documentation_mdbook.md
tskxz Oct 30, 2024
c0fe51b
Update Cargo.toml
tskxz Oct 30, 2024
d30a901
Update Cargo.toml
tskxz Oct 30, 2024
b50e3a5
Update README.md
tskxz Oct 30, 2024
9327fd6
Update README.md
tskxz Oct 30, 2024
aab56ba
Update README.md
tskxz Oct 31, 2024
2aabbfc
Update README.md
tskxz Oct 31, 2024
4094d99
Update README.md
tskxz Oct 31, 2024
9a2c111
Update docs/src/developer/documentation_mdbook.md
tskxz Oct 31, 2024
f70d7f5
Update tools/wasm-sample/README.md
tskxz Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
tskxz marked this conversation as resolved.
Show resolved Hide resolved

# 🎯 Motivation

Expand Down Expand Up @@ -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//)
tskxz marked this conversation as resolved.
Show resolved Hide resolved

![Architecture](docs/.drawio.svg)

Expand Down Expand Up @@ -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).
tskxz marked this conversation as resolved.
Show resolved Hide resolved

Thanks to all the people who already contributed!

Expand Down
2 changes: 1 addition & 1 deletion crates/libcgroups/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion crates/libcontainer/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion crates/liboci-cli/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion crates/youki/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/src/developer/documentation_mdbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
tskxz marked this conversation as resolved.
Show resolved Hide resolved

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.

Expand Down
2 changes: 1 addition & 1 deletion experiment/seccomp/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion experiment/selinux/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion tools/wasm-sample/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
tskxz marked this conversation as resolved.
Show resolved Hide resolved

```
"ociVersion": "1.0.2-dev",
Expand Down