diff options
author | Pawel Wieczorek <p.wieczorek2@samsung.com> | 2020-08-05 10:08:39 +0200 |
---|---|---|
committer | Morgan Richomme <morgan.richomme@orange.com> | 2020-08-10 14:30:55 +0000 |
commit | ddb59f3d732854e35cadb8468586ea12c9bb62af (patch) | |
tree | 34a857ec5623c6bc6ed96e30cad201474d90f550 /test/security/k8s | |
parent | a5b89b132a5b681ce0e81e46216443d0307c789f (diff) |
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 <b.grzybowski@partner.samsung.com>
Issue-ID: INT-1672
Change-Id: I120e216b0b48032bb7b80c23cad799cd6f7cca53
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
Diffstat (limited to 'test/security/k8s')
-rw-r--r-- | test/security/k8s/README | 45 | ||||
-rw-r--r--[l---------] | test/security/k8s/README.rst | 46 |
2 files changed, 45 insertions, 46 deletions
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 index 100b93820..b9e2dd5d2 120000..100644 --- a/test/security/k8s/README.rst +++ b/test/security/k8s/README.rst @@ -1 +1,45 @@ -README
\ No newline at end of file +############################## +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. |