Skip to content

Commit

Permalink
Updating documentation for installs. (#249)
Browse files Browse the repository at this point in the history
Addresses #248
  • Loading branch information
safaci2000 committed Feb 16, 2024
1 parent 8d22d88 commit 346cf2f
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 14 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/hugo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ on:
push:
# branches:
# - master
# Update for given branch for one of releases, otherwise only release on tags
# - feature/fixingReleaseDocs
tags:
- v*

Expand Down
11 changes: 6 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
name: Release GDG on Tag
on:
create:
tags:
- '*'

on:
push:
# branches:
# - master
tags:
- v*

jobs:
goreleaser:
Expand Down
2 changes: 1 addition & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ builds:
- CGO_ENABLED=0
binary: gdg-generate
ldflags: -s -w -X github.com/esnet/gdg/internal/version.GitCommit={{ .Commit }} -X github.com/esnet/gdg/internal/version.BuildDate={{ .Date }} -X github.com/esnet/gdg/internal/version.Version={{ .Tag }}
main: ./cmd/gen
main: ./cmd/gdg-generate
goos:
- linux
- windows
Expand Down
2 changes: 1 addition & 1 deletion Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ tasks:
desc: "Buiding {{ .BIN_NAME }}-generate {{ .VERSION }}"
cmds:
- echo "GOPATH=${GOPATH}"
- go build -ldflags "{{ .LD_FLAGS }}" -o bin/{{ .BIN_NAME }}-generate cmd/gen/main.go
- go build -ldflags "{{ .LD_FLAGS }}" -o bin/{{ .BIN_NAME }}-generate cmd/gdg-generate/main.go
install:
desc: "installing {{ .BIN_NAME }} {{ .VERSION }}"
cmds:
Expand Down
File renamed without changes.
28 changes: 21 additions & 7 deletions website/content/en/docs/gdg/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ The following packages are currently supported:
Install from package involves downloading the appropriate package from the [release](https://github.com/esnet/gdg/releases) and installing it as you usually do on your favorite Distro.

```sh
rpm -Uvh ./gdg_0.5.1_amd64.rpm
dpkg -i ./gdg_0.5.1_amd64.deb
rpm -Uvh ./gdg_0.5.3_amd64.rpm
dpkg -i ./gdg_0.5.3_amd64.deb
```

### Homebrew Installation
Expand All @@ -43,7 +43,7 @@ The docker tags are released started with 0.3.1. Each release will generate a m
You can see the available images [here](https://github.com/esnet/gdg/pkgs/container/gdg)

```sh
docker pull ghcr.io/esnet/gdg:0.5.1
docker pull ghcr.io/esnet/gdg:0.5.3
```

NOTE: ghcr.io/esnet/gdg:0.3 will also point to 0.3.1 until 0.3.2 is released after which it'll point to 0.3.2
Expand All @@ -54,7 +54,7 @@ Example compose.
version: '3.7'
services:
gdg:
image: ghcr.io/esnet/gdg:0.5.1
image: ghcr.io/esnet/gdg:0.5.3
command: "--help" ## Add additional parameters here
# command: "ds export" ## Pass any cmd on here.
volumes:
Expand All @@ -70,15 +70,29 @@ docker run -it --rm -v $(pwd)/config:/app/config -v $(pwd)/exports:/app/exports

### Installing via Go

If you have go install you may run the following command to install gdg
If you have go install you may run the following command to install gdg. Keep in mind there are two binaries you may install.

- gdg ==> Main binary that manages the various entities supported.
- gdg-generate => Helper utility that allows you to generate multiple dashboards given a valid configuration and seed data.

---

**gdg**
```sh
go install github.com/esnet/gdg@latest #for latest
go install github.com/esnet/gdg@v0.5.1 #for a specific version
go install github.com/esnet/gdg/cmd/gdg@latest #for latest
go install github.com/esnet/gdg/cmd/gdg@v0.5.3 #for a specific version
```

You can verify the version by running `gdg version`.

**gdg-generate**
```sh
go install github.com/esnet/gdg/cmd/gdg-generate@latest #for latest
go install github.com/esnet/gdg/cmd/gdg-generate@v0.5.3 #for a specific version
```

---

## Configuration

You can then create a simple configuration using `gdg tools ctx new` which will do a best effort to guide to setup a basic config that will get you up and going or read the more detailed documentation that can be found [here](/gdg/docs/gdg/configuration/)
Expand Down

0 comments on commit 346cf2f

Please sign in to comment.