From 948f6cceb3d83710b7bdc722d2696d70fc338ee3 Mon Sep 17 00:00:00 2001 From: Edouard Schweisguth Date: Mon, 8 Jan 2024 13:13:24 +0100 Subject: [PATCH] Fix broken links in readme (#159) * Fix #158 * Fix link in contributing --- CONTRIBUTING.md | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d20fa54f..2ec8aedad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ If a PR sits open for more than a month awaiting work or replies by the author, To add a new attack to KubeHound, please do the following: -+ Document the attack in the [edges documentation](./edges/) directory ++ Document the attack in the [edges documentation](./docs/reference/attacks) directory + Define the attack constraints in the graph database [schema builder](../deployments/kubehound/janusgraph/kubehound-db-init.groovy) + Create an implementation of the [edge.Builder](../pkg/kubehound/graph/edge/builder.go) interface that determines whether attacks are possible by quering the store database and writes any found as edges into the graph database + Create the [resources](../test/setup/test-cluster/attacks/) file in the test cluster that will introduce an instance of the attack into the test cluster diff --git a/README.md b/README.md index f3457498a..99d2949f2 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ A Kubernetes attack graph tool allowing automated calculation of attack paths be ## Quick Links -+ For an overview of the application architecture see the [design canvas](./docs/application/Architecture.excalidraw) -+ To see the attacks covered see the [edge definitions](./docs/edges/) ++ For an overview of the application architecture see the [design canvas](./docs/Architecture.excalidraw) ++ To see the attacks covered see the [edge definitions](./docs/reference/attacks) + To contribute a new attack to the project follow the [contribution guidelines](./CONTRIBUTING.md) ## Sample Attack Path @@ -241,7 +241,7 @@ The repository includes a suite of system tests that will do the following: The cluster setup and running instances can be found under [test/setup](./test/setup/) -If you need to manually access the system test environement with kubectl and other commands, you'll need to set (assuming you are at the root dir): +If you need to manually access the system test environment with kubectl and other commands, you'll need to set (assuming you are at the root dir): ```bash cd test/setup/ && export KUBECONFIG=$(pwd)/.kube-config