From e2ca590decc66f09dc6694a96841be8c40701246 Mon Sep 17 00:00:00 2001 From: Christian Petersen Date: Wed, 2 Apr 2025 13:17:22 -0400 Subject: [PATCH] Fix broken link to Datadog plugin in README.md Signed-off-by: Christian Petersen --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f94c9be..0035e01 100644 --- a/README.md +++ b/README.md @@ -25,20 +25,20 @@ At the most basic level, all a plugin needs to do is gather cost data given a ti ## Plugin setup - Pull the repo locally. -- Create a directory within the repo for the new plugin. Check out the [Datadog plugin](https://github.com/opencost/opencost-plugins/tree/main/datadog) for a reference to follow along with. +- Create a directory within the repo for the new plugin. Check out the [Datadog plugin](https://github.com/opencost/opencost-plugins/tree/main/pkg/plugins/datadog) for a reference to follow along with. - Create the plugin subdirectories: - - `//cmd/main/` + - `/pkg/plugins//cmd/main/` - This will contain the actual logic of the plugin. - - `//plugin/` + - `/pkg/plugins//plugin/` - This will contain the plugin config struct and any other structs for handling requests/responses in the plugin. - - `//tests/` + - `/pkg/plugins//tests/` - Highly recommended, this will contain tests to validate the functionality of the plugin. - Initialize the subproject: - - Within `//`, run `go mod init github.com/opencost/opencost-plugins/` and `go get github.com/hashicorp/go-plugin`. + - Within `</pkg/plugins//`, run `go mod init github.com/opencost/opencost-plugins/pkg/plugins/` and `go get github.com/hashicorp/go-plugin`. ## Design the configuration -All plugins require a configuration. For example, the [Datadog plugin configuration](https://github.com/opencost/opencost-plugins/blob/main/datadog/datadogplugin/datadogconfig.go) takes in some information required to authenticate with the Datadog API. This configuration will be defined by a struct inside `//plugin/`. +All plugins require a configuration. For example, the [Datadog plugin configuration](https://github.com/opencost/opencost-plugins/blob/main/pkg/plugins/datadog/datadogplugin/datadogconfig.go) takes in some information required to authenticate with the Datadog API. This configuration will be defined by a struct inside `/pkg/plugins//plugin/`. ## Implement the plugin @@ -51,13 +51,13 @@ Once the configuration is designed, it's time to write the plugin. Within `