From ddb59f3d732854e35cadb8468586ea12c9bb62af Mon Sep 17 00:00:00 2001 From: Pawel Wieczorek Date: Wed, 5 Aug 2020 10:08:39 +0200 Subject: Drop using symlinks for documentation markup rendering Keeping only symlinks as the markup indicator does not trigger CI on relevant patches changing documentation contents (there's no change in symlink). This can be resolved by dropping symlinks usage entirely. Sphinx and RTD aren't going anywhere anytime soon. To make sure all symlinks were replaced following one-liner was used: $ find . -type l -name "*.rst" -exec readlink -e {} \; \ | xargs -I% git mv -f %{,.rst} which finds all the symlinks in the repo with "*.rst" suffix, then reads which file they link to and finally replaces given symlink with that file. This solution was suggested by: Bartek Grzybowski Issue-ID: INT-1672 Change-Id: I120e216b0b48032bb7b80c23cad799cd6f7cca53 Signed-off-by: Pawel Wieczorek --- test/security/k8s/README | 45 ------------------------------------------- test/security/k8s/README.rst | 46 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 45 insertions(+), 46 deletions(-) delete mode 100644 test/security/k8s/README mode change 120000 => 100644 test/security/k8s/README.rst (limited to 'test/security/k8s') diff --git a/test/security/k8s/README b/test/security/k8s/README deleted file mode 100644 index b9e2dd5d2..000000000 --- a/test/security/k8s/README +++ /dev/null @@ -1,45 +0,0 @@ -############################## -K8s secure configuration check -############################## - -Utility for checking if Kubernetes cluster configuration follows security recommendations. - -*************** -Getting started -*************** - -Prerequisites -============= - -Build ------ - -- make -- go_ - -.. _go: https://golang.org/doc/install - -Test ----- - -- Ginkgo_ - -.. _Ginkgo: https://onsi.github.io/ginkgo/#getting-ginkgo - -Running -======= - -Calling:: - - make run - -will build and run configuration check executable. It is the default target. - -Testing -======= - -Calling:: - - make test - -will run tests. diff --git a/test/security/k8s/README.rst b/test/security/k8s/README.rst deleted file mode 120000 index 100b93820..000000000 --- a/test/security/k8s/README.rst +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/test/security/k8s/README.rst b/test/security/k8s/README.rst new file mode 100644 index 000000000..b9e2dd5d2 --- /dev/null +++ b/test/security/k8s/README.rst @@ -0,0 +1,45 @@ +############################## +K8s secure configuration check +############################## + +Utility for checking if Kubernetes cluster configuration follows security recommendations. + +*************** +Getting started +*************** + +Prerequisites +============= + +Build +----- + +- make +- go_ + +.. _go: https://golang.org/doc/install + +Test +---- + +- Ginkgo_ + +.. _Ginkgo: https://onsi.github.io/ginkgo/#getting-ginkgo + +Running +======= + +Calling:: + + make run + +will build and run configuration check executable. It is the default target. + +Testing +======= + +Calling:: + + make test + +will run tests. -- cgit 1.2.3-korg