Skip to content

Commit b5f3c8a

Browse files
committed
docs: how to add/update projects
Signed-off-by: flavono123 <flavono123@gmail.com>
1 parent 8cb9ae8 commit b5f3c8a

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,23 @@ Contributions are welcome!
1818
- run `npm install`
1919
- run `npm run dev`
2020

21+
### Adding/Updating projects
22+
23+
- add the project to the [`src/lib/kube/projects.ts`](src/lib/kube/projects.ts) file(skip for just updating)
24+
25+
```ts
26+
{
27+
name: "New Project",
28+
slug: "new-project",
29+
logo: "https://example.com/logo.png",
30+
repo: "new-org/new-project",
31+
pathToManifests: ["path/to/manifests"],
32+
}
33+
```
34+
35+
- run `GH_TOKEN=... npm run download` to download the manifests
36+
- run `npm run dev` to check
37+
2138
## 📃 License
2239

2340
MIT

0 commit comments

Comments
 (0)