From c8ba30f943cb348e6367ba5d78aa9aff6b5b3a6e Mon Sep 17 00:00:00 2001 From: Peng Tao Date: Sun, 27 Sep 2020 16:46:40 +0800 Subject: [PATCH] docs: fix static check errors Somehow we are not running static checks for a long time. And that ended up with a lot for errors. * Ensure debug options are valid is dropped * fix snap links * drop extra CONTRIBUTING.md * reference kata-pkgsync * move CODEOWNERS to proper place * remove extra CODE_OF_CONDUCT.md. * fix spell checker error on Developer-Guide.md Signed-off-by: Peng Tao --- docs/CODEOWNERS => CODEOWNERS | 3 +-- docs/CODE_OF_CONDUCT.md | 3 --- docs/CONTRIBUTING.md | 5 ----- docs/Developer-Guide.md | 12 +++++------- docs/README.md | 2 +- snap/README.md | 10 +++++----- src/runtime/CONTRIBUTING.md | 5 ----- .../virtcontainers/documentation/Developers.md | 2 +- .../pkg/agent/protocols/client/client.go | 2 +- tools/packaging/CODE_OF_CONDUCT.md | 3 --- tools/packaging/CONTRIBUTING.md | 1 - tools/packaging/README.md | 6 +++++- 12 files changed, 19 insertions(+), 35 deletions(-) rename docs/CODEOWNERS => CODEOWNERS (90%) delete mode 100644 docs/CODE_OF_CONDUCT.md delete mode 100644 docs/CONTRIBUTING.md delete mode 100644 src/runtime/CONTRIBUTING.md delete mode 100644 tools/packaging/CODE_OF_CONDUCT.md delete mode 100644 tools/packaging/CONTRIBUTING.md diff --git a/docs/CODEOWNERS b/CODEOWNERS similarity index 90% rename from docs/CODEOWNERS rename to CODEOWNERS index e48c094af2..f82bae0d54 100644 --- a/docs/CODEOWNERS +++ b/CODEOWNERS @@ -1,4 +1,4 @@ -# Copyright 2019 Intel Corporation. +# Copyright (c) 2019 Intel Corporation # # SPDX-License-Identifier: Apache-2.0 # @@ -10,4 +10,3 @@ # used. See https://help.github.com/articles/about-code-owners/ *.md @kata-containers/documentation - diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md deleted file mode 100644 index 6460adf39d..0000000000 --- a/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,3 +0,0 @@ -## Kata Containers Documentation Code of Conduct - -Kata Containers follows the [OpenStack Foundation Code of Conduct](https://www.openstack.org/legal/community-code-of-conduct/). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 8a3af744a6..0000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing - -## This repo is part of [Kata Containers](https://katacontainers.io) - -For details on how to contribute to the Kata Containers project, please see the main [contributing document](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md). \ No newline at end of file diff --git a/docs/Developer-Guide.md b/docs/Developer-Guide.md index b66f02b1ee..20293490b1 100644 --- a/docs/Developer-Guide.md +++ b/docs/Developer-Guide.md @@ -39,15 +39,13 @@ * [Enable agent debug console](#enable-agent-debug-console) * [Start `kata-monitor`](#start-kata-monitor) * [Connect to debug console](#connect-to-debug-console) - * [Traditional debug console setup](#traditional-simple-debug-console-setup) + * [Traditional debug console setup](#traditional-debug-console-setup) * [Create a custom image containing a shell](#create-a-custom-image-containing-a-shell) * [Create a debug systemd service](#create-a-debug-systemd-service) * [Build the debug image](#build-the-debug-image) * [Configure runtime for custom debug image](#configure-runtime-for-custom-debug-image) - * [Ensure debug options are valid](#ensure-debug-options-are-valid) * [Create a container](#create-a-container) * [Connect to the virtual machine using the debug console](#connect-to-the-virtual-machine-using-the-debug-console) - * [Obtain details of the image](#obtain-details-of-the-image) * [Capturing kernel boot logs](#capturing-kernel-boot-logs) # Warning @@ -450,7 +448,7 @@ contain either `/bin/sh` or `/bin/bash`. #### Enable agent debug console -Enable debug_console_enabled in the configuration.toml configuration file: +Enable debug_console_enabled in the `configuration.toml` configuration file: ``` [agent.kata] @@ -461,7 +459,7 @@ This will pass `agent.debug_console agent.debug_console_vport=1026` to agent as #### Start `kata-monitor` -The `kata-runtime exec` command needs `kata-monitor` to get the sandbox's `vsock` address to connect to, firt start `kata-monitor`. +The `kata-runtime exec` command needs `kata-monitor` to get the sandbox's `vsock` address to connect to, first start `kata-monitor`. ``` $ sudo kata-monitor @@ -503,7 +501,7 @@ the following steps (using rootfs or initrd image). > > Look for `INIT_PROCESS=systemd` in the `config.sh` osbuilder rootfs config file > to verify an osbuilder distro supports systemd for the distro you want to build rootfs for. -> For an example, see the [Clear Linux config.sh file](../tools/osbuilder/blob/master/rootfs-builder/clearlinux/config.sh). +> For an example, see the [Clear Linux config.sh file](../tools/osbuilder/rootfs-builder/clearlinux/config.sh). > > For a non-systemd-based distro, create an equivalent system > service using that distro’s init system syntax. Alternatively, you can build a distro @@ -589,7 +587,7 @@ to avoid all subsequently created containers from using the debug image. #### Create a container -Create a container as normal. For example using crictl: +Create a container as normal. For example using `crictl`: ``` $ sudo crictl run -r kata container.yaml pod.yaml diff --git a/docs/README.md b/docs/README.md index 8a5c6daa3d..efea181844 100644 --- a/docs/README.md +++ b/docs/README.md @@ -54,7 +54,7 @@ Documents that help to understand and contribute to Kata Containers. * [Developer Guide](Developer-Guide.md): Setup the Kata Containers developing environments * [How to contribute to Kata Containers](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md) -* [Code of Conduct](CODE_OF_CONDUCT.md) +* [Code of Conduct](../CODE_OF_CONDUCT.md) ### Code Licensing diff --git a/snap/README.md b/snap/README.md index f0982adb8b..b2e69e5ee1 100644 --- a/snap/README.md +++ b/snap/README.md @@ -84,12 +84,12 @@ then a new configuration file can be [created](#configure-kata-containers) and [configured][7]. [1]: https://docs.snapcraft.io/snaps/intro -[2]: ../../../docs/design/architecture.md#root-filesystem-image +[2]: ../docs/design/architecture.md#root-filesystem-image [3]: https://docs.snapcraft.io/reference/confinement#classic [4]: https://github.com/kata-containers/runtime#configuration [5]: https://docs.docker.com/engine/reference/commandline/dockerd -[6]: ../../../docs/install/docker/ubuntu-docker-install.md -[7]: ../../../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image +[6]: ../docs/install/docker/ubuntu-docker-install.md +[7]: ../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image [8]: https://snapcraft.io/kata-containers -[9]: ../../../docs/Developer-Guide.md#run-kata-containers-with-docker -[10]: ../../../docs/Developer-Guide.md#run-kata-containers-with-kubernetes +[9]: ../docs/Developer-Guide.md#run-kata-containers-with-docker +[10]: ../docs/Developer-Guide.md#run-kata-containers-with-kubernetes diff --git a/src/runtime/CONTRIBUTING.md b/src/runtime/CONTRIBUTING.md deleted file mode 100644 index 8a3af744a6..0000000000 --- a/src/runtime/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing - -## This repo is part of [Kata Containers](https://katacontainers.io) - -For details on how to contribute to the Kata Containers project, please see the main [contributing document](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md). \ No newline at end of file diff --git a/src/runtime/virtcontainers/documentation/Developers.md b/src/runtime/virtcontainers/documentation/Developers.md index 81d5021b9c..6ec807658b 100644 --- a/src/runtime/virtcontainers/documentation/Developers.md +++ b/src/runtime/virtcontainers/documentation/Developers.md @@ -51,5 +51,5 @@ This will: # Submitting changes For details on the format and how to submit changes, refer to the -[Contributing](../../CONTRIBUTING.md) document. +[Contributing](../../../../CONTRIBUTING.md) document. diff --git a/src/runtime/virtcontainers/pkg/agent/protocols/client/client.go b/src/runtime/virtcontainers/pkg/agent/protocols/client/client.go index c3b1c9390b..db6a4f1123 100644 --- a/src/runtime/virtcontainers/pkg/agent/protocols/client/client.go +++ b/src/runtime/virtcontainers/pkg/agent/protocols/client/client.go @@ -1,4 +1,4 @@ -// Copyright 2017 HyperHQ Inc. +// Copyright (c) 2017 HyperHQ Inc. // // SPDX-License-Identifier: Apache-2.0 // diff --git a/tools/packaging/CODE_OF_CONDUCT.md b/tools/packaging/CODE_OF_CONDUCT.md deleted file mode 100644 index 1d9d931ad4..0000000000 --- a/tools/packaging/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,3 +0,0 @@ -## Kata Containers CI Code of Conduct - -Kata Containers follows the [OpenStack Foundation Code of Conduct](https://www.openstack.org/legal/community-code-of-conduct/). diff --git a/tools/packaging/CONTRIBUTING.md b/tools/packaging/CONTRIBUTING.md deleted file mode 100644 index bdeeb024a9..0000000000 --- a/tools/packaging/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -For details on how to contribute to the Kata Containers project, please see the main [contributing document](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md). diff --git a/tools/packaging/README.md b/tools/packaging/README.md index 69d09c556d..7a8a7125ec 100644 --- a/tools/packaging/README.md +++ b/tools/packaging/README.md @@ -31,7 +31,7 @@ running Kubernetes Cluster very straightforward. ## Build a snap package -See [the snap documentation](snap). +See [the snap documentation](../../snap). ## Build static binaries @@ -61,6 +61,10 @@ See [the Jenkins documentation](Jenkinsfiles). See the [scripts documentation](scripts). +## Sync packages + +See [the `kata-pkgsync` documentation](cmd/kata-pkgsync). + ## Credits Kata Containers packaging uses [packagecloud](https://packagecloud.io) for