Skip to content

Commit

Permalink
feat: add more links and improve content formatting unity
Browse files Browse the repository at this point in the history
  • Loading branch information
Traxmaxx committed Oct 12, 2023
1 parent 096740e commit 0138660
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 43 deletions.
74 changes: 32 additions & 42 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,32 +69,29 @@ Following these steps will ensure that your contributions are well-received, rev
```
6. While submitting Pull Request, **make sure to change the base branch from**: [master](https://github.com/tailwarden/komiser/tree/master) to [develop](v). Making sure to avoid any possible merge conflicts
> ### Keeping your Fork Up-to-Date
>
> If you plan on doing anything more than just a tiny quick fix, you’ll want to **make sure you keep your fork up to date** by tracking the original [“upstream” repo](https://github.com/tailwarden/komiser) that you forked.
>
> Follow the steps given below to do so:
>
> 1. Add the 'upstream' repo to list of remotes:
>
> ```bash
> git remote add upstream https://github.com/tailwarden/komiser.git
> ```
>
> 2. Fetch upstream repo’s branches and latest commits:
>
> ```bash
> git fetch upstream
> ```
>
> 3. Checkout to the **`develop`** branch and merge the upstream:
>
> ```bash
> git checkout develop
> git merge upstream/develop
> ```
>
> **Now, your local 'develop' branch is up-to-date with everything modified upstream!**
### Keeping your Fork Up-to-Date
If you plan on doing anything more than just a tiny quick fix, you’ll want to **make sure you keep your fork up to date** by tracking the original [“upstream” repo](https://github.com/tailwarden/komiser) that you forked.
Follow the steps given below to do so:
1. Add the 'upstream' repo to list of remotes:
```bash
git remote add upstream https://github.com/tailwarden/komiser.git
```
2. Fetch upstream repo’s branches and latest commits:
```bash
git fetch upstream
```
3. Checkout to the **`develop`** branch and merge the upstream:
```bash
git checkout develop
git merge upstream/develop
```
**Now, your local 'develop' branch is up-to-date with everything modified upstream!**
## Contributing to Komiser Engine
Expand Down Expand Up @@ -137,7 +134,6 @@ Create a new **`provider_name.go`** file under **`providers/provider_name`** dir
**Step 2:**
Add the following boilerplate code, which defines the structure of any new provider to be added:
```go
package PROVIDER_NAME
Expand Down Expand Up @@ -171,7 +167,6 @@ Then, the main task is writing the code to fetch all the resources/services usin

**Step 3:**
Add the information about the appropriate provider's SDK client in [**`providers/provider.go`**](https://github.com/tailwarden/komiser/blob/develop/providers/providers.go) file:
```go
type ProviderClient struct {
Expand Down Expand Up @@ -200,7 +195,7 @@ type AzureClient struct {
Add the provider configuration in TOML format in your **`config.toml`** file, which will be used by Komiser to configure your account with the CLI.
An example configuration entry for configuring a Google Cloud account in the **`config.toml`** file would look like this:
```
```toml
[[gcp]]
name="production"
source="ENVIRONMENT_VARIABLES"
Expand All @@ -210,15 +205,13 @@ profile="production"
**Step 5:**
Build a new Komiser binary with the latest code changes by running:
```
```bash
go build
```
**Step 6:**
Start a new Komiser development server using this new binary:
```
```bash
./komiser start
```
Expand All @@ -233,7 +226,6 @@ Create a new file **`servicename.go`** under the path **`providers/provider_name

**Step 2:**
Add the following boilerplate code, which defines the structure of any new service/resource to be added for a cloud provider:

```go
package service
Expand Down Expand Up @@ -312,7 +304,7 @@ Here are the steps to setup and access the Komiser dashboard:
**Step 0:**
Install the necessary Go dependencies using the following command:
```
```bash
go mod download
```
Expand Down Expand Up @@ -343,7 +335,8 @@ Paste in the following example content:
file="komiser.db"
```
You can find more options in our [Quickstart Guide](https://docs.komiser.io/getting-started/quickstart). It shows you how to connect to PostreSQL and other things.
> You can find more options in our [Quickstart Guide](https://docs.komiser.io/getting-started/quickstart).
> For example it shows you how to connect to PostreSQL and other things.
**Edit the config**
Expand All @@ -356,13 +349,10 @@ From the root folder, start the Komiser backend server using the following comma
go run *.go start --config ./config.toml
```
> As soon as you run this, you'll be able to access the dashboard at `http://localhost:3002`.
>
> As soon as you run this, you'll be able to access the dashboard at [`http://localhost:3002/`](http://localhost:3002).
> An important point to note here is, this dashboard only reflects the changes from the **`master`** branch.
>
> For our purpose, we certainly need changes to be reflected from our development branch!
> For our purpose, we certainly need changes to be reflected from our development branch!
> Follow the steps given below to do so 👇
>
**Step 3:**
Head over to the **`dashboard`** directory:
Expand All @@ -386,7 +376,7 @@ npm run dev
The official supported NodeJS version is the latest `18.x.x` LTS release.
You'll be able to access the dashboard at **`http://localhost:3002/`**
You'll be able to access the dashboard at [**`http://localhost:3002/`**](http://localhost:3002)
![](https://hackmd.io/_uploads/ryvOPmFla.png)
Expand Down
2 changes: 1 addition & 1 deletion dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ NEXT_PUBLIC_API_URL=http://localhost:3000
```

2. open [http://localhost:3002/](http://localhost:3002). If you see the dashboard, congrats! It's all up and running correctly.
<img width="1411" alt="image" src="https://user-images.githubusercontent.com/13384559/224318056-3d2c68bc-aa56-49c8-841a-bb297e380dc9.png">
<img width="1411" alt="image" src="https://user-images.githubusercontent.com/13384559/224318056-3d2c68bc-aa56-49c8-841a-bb297e380dc9.png">

> If you get an error page such as this, please refer to the logs and our [docs](https://docs.komiser.io/docs/introduction/getting-started).
> <img width="1411" alt="image" src="https://user-images.githubusercontent.com/13384559/224320642-0bf6814b-d97a-4ad9-95a0-ca82e353c5d0.png">
Expand Down

0 comments on commit 0138660

Please sign in to comment.