Skip to content

Commit

Permalink
Fix broken links in readme (#159)
Browse files Browse the repository at this point in the history
* Fix #158

* Fix link in contributing
  • Loading branch information
edznux-dd authored Jan 8, 2024
1 parent df8ac7c commit 948f6cc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ A Kubernetes attack graph tool allowing automated calculation of attack paths be

## Quick Links <!-- omit in toc -->

+ 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 <!-- omit in toc -->
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 948f6cc

Please sign in to comment.