From 88766c154ae3e47191a776b54d191ffb55adab78 Mon Sep 17 00:00:00 2001 From: Tom Wieczorek Date: Thu, 14 Dec 2023 16:03:32 +0100 Subject: [PATCH] Fix Code of Conduct linking in docs There was a symlink that pulled in the Code of Conduct from the repository root into the docs build. The link in the Code of Conduct was supposed to be working from within the docs. Cleanup that situation by removing one Code of Conduct file and update the symlink. Also let changes to the Code of Conduct trigger the docs build workflow, so that these errors might be caught earlier in the future. Fixes: 7aa222fa6 ("Update link to Code of Conduct document") Signed-off-by: Tom Wieczorek --- .github/workflows/build-docs.yml | 1 + CODE_OF_CONDUCT.md | 4 ++-- docs/CODE_OF_CONDUCT.md | 1 - docs/contributors/CODE_OF_CONDUCT.md | 4 +--- docs/contributors/overview.md | 2 +- 5 files changed, 5 insertions(+), 7 deletions(-) delete mode 120000 docs/CODE_OF_CONDUCT.md mode change 100644 => 120000 docs/contributors/CODE_OF_CONDUCT.md diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 17fbd1ae9753..ec58facc1f45 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -8,6 +8,7 @@ on: paths: - mkdocs.yml - embedded-bins/Makefile.variables + - CODE_OF_CONDUCT.md - docs/** jobs: diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2fd659d9b451..c980a14c0e76 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ -# k0s Community Code Of Conduct +# K0s Community Code of Conduct -Please refer to our [contributor code of conduct](docs/contributors/CODE_OF_CONDUCT.md). +K0s follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md deleted file mode 120000 index 0400d574603b..000000000000 --- a/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1 +0,0 @@ -../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/contributors/CODE_OF_CONDUCT.md b/docs/contributors/CODE_OF_CONDUCT.md deleted file mode 100644 index f23dd3d4dccf..000000000000 --- a/docs/contributors/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,3 +0,0 @@ -# k0s Community Code of Conduct - -k0s follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/docs/contributors/CODE_OF_CONDUCT.md b/docs/contributors/CODE_OF_CONDUCT.md new file mode 120000 index 000000000000..a3613c99f0b0 --- /dev/null +++ b/docs/contributors/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +../../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/contributors/overview.md b/docs/contributors/overview.md index 5868ae4e7251..f6406d767c62 100644 --- a/docs/contributors/overview.md +++ b/docs/contributors/overview.md @@ -8,7 +8,7 @@ When contributing to this repository, please consider first discussing the chang Our code of conduct can be found in the link below. Please follow it in all your interactions with the project. -- [Code Of Conduct](./CODE_OF_CONDUCT.md) +- [Code of Conduct](./CODE_OF_CONDUCT.md) ## GitHub Workflow