Skip to content
This repository was archived by the owner on Nov 21, 2022. It is now read-only.

Commit 3f3f75e

Browse files
author
Archit Sharma
committed
Add release notes, update README
1 parent 49e48ba commit 3f3f75e

File tree

3 files changed

+30
-9
lines changed

3 files changed

+30
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Table of Contents
1111
- [Control Flow](#control-flow)
1212
- [FAQs](#faqs)
1313
- [Contributions](#contributions)
14-
- [TODOs](#todos)
1514
- [Issue Tracker](#issue-tracker)
15+
- [Upcoming Features](#upcoming-features)
1616
- [License](#license)
1717

1818
# Sarjitsu
@@ -243,19 +243,20 @@ Files generated in RHEL 5 OS (old enough) ..upto the ones generated by the lates
243243

244244
# Contributions
245245

246-
### TODOs
247-
248-
- Add service discovery
249-
- An update to sarjitsu, for nested docs. Refer to [PR #4694 of grafana](https://github.com/grafana/grafana/pull/4694) for more.
250-
251-
For more, refer to `docs/TODO.md`
252-
253-
If you think there's a bug in sarjitsu, you're welcome to open an issue here on github and could submit PRs for the same. Any refactoring suggestions/PRs to the app are also welcome.
246+
Please use Github issues list and it's features for contributions. [Click here](https://github.com/distributed-system-analysis/sarjitsu/issues) list of issues. If you think there's a bug in sarjitsu, you're welcome to open an issue here on github and could submit PRs for the same. Any refactoring suggestions/PRs to the app are also welcome.
254247

255248
### Issue Tracker
256249

257250
GitHub Issues and Pull Requests managed via [Waffle.io](https://waffle.io/arcolife/sarjitsu)
258251

252+
### Upcoming features
253+
254+
- Statistics about top N devices. Example: CPUs, Disks or Network devices.
255+
- Options to integrate this with hybrid cloud ecosystem.
256+
- Service Discovery for individual components.
257+
- Nested documents support in Grafana (Network, CPU, Disks, ..). Refer to [PR #4694 of grafana](https://github.com/grafana/grafana/pull/4694) for more.
258+
- Timeshift feature to compare 2 different sa binaries
259+
259260
### LICENSE
260261

261262
Refer to GPL v3 `LICENSE` file included in the repo, for reference.

RELEASE-NOTES

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Sarjitsu Release Notes
2+
3+
For details, kindly refer to blog post at:
4+
5+
- http://arcolife.github.io/blog/2016/06/06/sarjitsu-a-project-on-visualizing-your-systems-activity/
6+
7+
## Release Highlights
8+
9+
- issues/todo list: remove docs/TODO.md (shifted to github issues)
10+
- lib/backend: nodejs powered to python-flask powered. Also, threading for multi file uploads.
11+
- commandline uploads: refactor vizit script to display single table
12+
- setup.sh: various checks during installation
13+
- 12 factor addons: graceful shutdown and restart scripts. better cleanup scripts for complete setup removal
14+
15+
## Breaking Changes
16+
17+
- add index_sar as a separate lib
18+
- config paths / contents changed
19+
- vizit cmdline tool refactored

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v2.0

0 commit comments

Comments
 (0)