Skip to content

Commit

Permalink
Merge pull request #2 from box/hakan
Browse files Browse the repository at this point in the history
Add status badges to the readme
  • Loading branch information
ahakanbaba authored Jun 8, 2018
2 parents 0a7ef9c + dd94c5c commit e6188ed
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# wavectl

[![CircleCI](https://circleci.com/gh/box/wavectl.svg?style=svg)](https://circleci.com/gh/box/wavectl) [![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)

A command line client for [Wavefront](https://www.wavefront.com) inspired by [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) and [git](https://git-scm.com/docs) command line tools.

## Example Commands
Expand Down
14 changes: 7 additions & 7 deletions doc/GitIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Each `pull` command creates a new commit with the changes pulled from the Wavefr

```
$ git -C /tmp/GitIntegrationPull/alerts log --oneline
e8e31e4 Added files due to pull <resource> cmd:/Users/hbaba/box/src/skynet/wavectl/doc/bin/wavectl pull --inGit /tmp/GitIntegrationPull/alerts alert
2378f59 Initial commit with the README.md file
774ccab Added files due to pull <resource> cmd:/Users/hbaba/box/src/skynet/wavectl/doc/bin/wavectl pull --inGit /tmp/GitIntegrationPull/alerts alert
4a6b940 Initial commit with the README.md file
```

If you execute a long running daemon executing periodic pulls from Wavefront, an extensive git history can be built. The git history will correspond to users' edits to alerts and dashboards.
Expand All @@ -52,9 +52,9 @@ For example:

```
$ git -C /tmp/GitIntegrationPull/alerts log 1523082347619.alert
commit e8e31e45a6db2e1103b3a5b0b39d03f73cca4d25
commit 774ccab540faf10e1ebfa0126ab8c1e9f033195d
Author: Hakan Baba <hakanbaba83@gmail.com>
Date: Tue Jun 5 00:03:13 2018 -0700
Date: Thu Jun 7 22:39:45 2018 -0700
Added files due to pull <resource> cmd:/Users/hbaba/box/src/skynet/wavectl/doc/bin/wavectl pull --inGit /tmp/GitIntegrationPull/alerts alert
```
Expand All @@ -63,9 +63,9 @@ For example:

```
$ git -C /tmp/GitIntegrationPull/alerts log -S snoozed 1523082349048.alert
commit e8e31e45a6db2e1103b3a5b0b39d03f73cca4d25
commit 774ccab540faf10e1ebfa0126ab8c1e9f033195d
Author: Hakan Baba <hakanbaba83@gmail.com>
Date: Tue Jun 5 00:03:13 2018 -0700
Date: Thu Jun 7 22:39:45 2018 -0700
Added files due to pull <resource> cmd:/Users/hbaba/box/src/skynet/wavectl/doc/bin/wavectl pull --inGit /tmp/GitIntegrationPull/alerts alert
```
Expand Down Expand Up @@ -133,7 +133,7 @@ Submit your changes to the local repo:

```
$ git -C /tmp/GitIntegrationPush/alerts commit -a -m "proc. is replaced with host.proc."
[master faf5576] proc. is replaced with host.proc.
[master 262fe69] proc. is replaced with host.proc.
3 files changed, 6 insertions(+), 6 deletions(-)
```

Expand Down
3 changes: 2 additions & 1 deletion doc/sphinx/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@


\# wavectl

\[!\[CircleCI\]\(https://circleci.com/gh/box/wavectl.svg?style=svg\)\]\(https://circleci.com/gh/box/wavectl\)
\[!\[Project Status\]\(http://opensource.box.com/badges/active.svg\)\]\(http://opensource.box.com/badges\)

A command line client for \[Wavefront\]\(https://www.wavefront.com\) inspired by
\[kubectl\]\(https://kubernetes.io/docs/reference/kubectl/overview/\) and
Expand Down

0 comments on commit e6188ed

Please sign in to comment.