Skip to content

Commit

Permalink
Merge pull request #16 from liubogithub/liubo/dev/doc_fix
Browse files Browse the repository at this point in the history
Fix stale links of docs
  • Loading branch information
changweige authored Jan 26, 2022
2 parents db16238 + 4d18e7d commit ca0c5d0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Nydus-snapshotter is a **non-core** sub-project of containerd.

Pulling and unpacking OCI container image are time consuming when start a container. [Nydus](https://github.com/dragonflyoss/image-service) is a vendor-neutral project aiming at mitigating the problem. It designs a new container image oriented and optimized file system format with capability of on-demand read. For instructions on how to build nydus container image, please refer to [nydusify](https://github.com/changweige/image-service/blob/master/docs/nydusify.md) conversion tool.
Pulling and unpacking OCI container image are time consuming when start a container. [Nydus](https://github.com/dragonflyoss/image-service) is a vendor-neutral project aiming at mitigating the problem. It designs a new container image oriented and optimized file system format with capability of on-demand read. For instructions on how to build nydus container image, please refer to [nydusify](https://github.com/dragonflyoss/image-service/blob/master/docs/nydusify.md) conversion tool.

## Building

Expand Down Expand Up @@ -43,7 +43,7 @@ Find a suitable `nydusd` release for you from [nydus releases page](https://gith
## Configure Nydus

Nydus is configured by a json file which is required now. Because nydus container images are likely stored in a registry, where auth has to be provided.
Please follow instructions to [configure nydus](./documents/configure_nydus.md) configure nydus making it work properly in your environment.
Please follow instructions to [configure nydus](./docs/configure_nydus.md) configure nydus making it work properly in your environment.

## Start Nydus Snapshotter

Expand Down Expand Up @@ -107,7 +107,7 @@ NOTE: A potential drawback using CRI is that we can hardly specify snapshotter t
snapshotter = "nydus"
```

Use `crictl` to debug starting container via Kubernetes CRI. Dry run [steps](.documents/../documents/crictl_dry_run.md) of using `ctrctl` can be found in [documents](./documents).
Use `crictl` to debug starting container via Kubernetes CRI. Dry run [steps](./docs/crictl_dry_run.md) of using `ctrctl` can be found in [documents](./docs).

## Community

Expand Down

0 comments on commit ca0c5d0

Please sign in to comment.