X Tutup
Skip to content

Commit 7dffdfa

Browse files
dmcgowandmcgowan
committed
Move documentation and helper directories out of root
Signed-off-by: Derek McGowan <derek@mcg.dev>
1 parent a4f4a43 commit 7dffdfa

File tree

11 files changed

+8
-8
lines changed

11 files changed

+8
-8
lines changed

‎BUILDING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ make
6969
sudo make install
7070
```
7171

72-
Make sure to follow the guidelines for versioning in [RUNC.md](RUNC.md) for the
72+
Make sure to follow the guidelines for versioning in [RUNC.md](/docs/RUNC.md) for the
7373
best results.
7474

7575
## Build containerd

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ bin/cri-integration.test:
188188

189189
cri-integration: binaries bin/cri-integration.test ## run cri integration tests
190190
@echo "$(WHALE) $@"
191-
@./hack/test-cri-integration.sh
191+
@./script/test/cri-integration.sh
192192
@rm -rf bin/cri-integration.test
193193

194194
benchmark: ## run benchmarks tests

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Please be aware: nightly builds might have critical bugs, it's not recommended f
4949

5050
Runtime requirements for containerd are very minimal. Most interactions with
5151
the Linux and Windows container feature sets are handled via [runc](https://github.com/opencontainers/runc) and/or
52-
OS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft). The current required version of `runc` is always listed in [RUNC.md](/RUNC.md).
52+
OS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft). The current required version of `runc` is always listed in [RUNC.md](/docs/RUNC.md).
5353

5454
There are specific features
5555
used by containerd core code and snapshotters that will require a minimum kernel
@@ -223,7 +223,7 @@ effect.
223223
address = "/var/run/mysnapshotter.sock"
224224
```
225225

226-
See [PLUGINS.md](PLUGINS.md) for how to create plugins
226+
See [PLUGINS.md](/docs/PLUGINS.md) for how to create plugins
227227

228228
### Releases and API Stability
229229

fuzz/filters_fuzzers.go renamed to contrib/fuzz/filters_fuzzers.go

File renamed without changes.

fuzz/platforms_fuzzers.go renamed to contrib/fuzz/platforms_fuzzers.go

File renamed without changes.

PLUGINS.md renamed to docs/PLUGINS.md

File renamed without changes.

RUNC.md renamed to docs/RUNC.md

File renamed without changes.

‎docs/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ However, if you want to integrate containerd into your project we have an easy t
66

77
In this guide we will pull and run a redis server with containerd using the client package.
88
We will assume that you are running a modern linux host for this example with a compatible build of `runc`.
9-
Please refer to [RUNC.md](/RUNC.md) for the currently supported version of `runc`.
9+
Please refer to [RUNC.md](/docs/RUNC.md) for the currently supported version of `runc`.
1010
This project requires Go 1.9.x or above.
1111
If you need to install Go or update your currently installed one, please refer to Go install page at https://golang.org/doc/install.
1212

‎docs/remote-snapshotter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This enables containerd to lazily pull images from standard-compliant registries
1212
## The containerd client API
1313

1414
The containerd client's `Pull` API with unpacking-mode allows the underlying snapshotter to query for remote snapshots before fetching content.
15-
Remote snapshotter needs to be plugged into containerd in [the same ways as normal snapshotters](/PLUGINS.md).
15+
Remote snapshotter needs to be plugged into containerd in [the same ways as normal snapshotters](/docs/PLUGINS.md).
1616

1717
```go
1818
image, err := client.Pull(ctx, ref,

hack/test-cri-integration.sh renamed to script/test/cri-integration.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
set -o nounset
1818
set -o pipefail
1919

20-
source $(dirname "${BASH_SOURCE[0]}")/test-utils.sh
20+
source $(dirname "${BASH_SOURCE[0]}")/utils.sh
2121
cd ${ROOT}
2222

2323
# FOCUS focuses the test to run.

0 commit comments

Comments
 (0)
X Tutup