From cbcede444dac1dbce07d3bcdb7071c7a6971d8bb Mon Sep 17 00:00:00 2001
From: Kristinn <kristinn@log2timeline.net>
Date: Wed, 11 Mar 2020 13:53:01 +0000
Subject: [PATCH] Adding comments to the TS sketch analyzer template (#79)

* Making minor changes to the TS sketch analyzer template.

* updating docs
---
 docs/sources/user/Setting-Up-Virtualenv.md    | 22 +++++++++++++++++++
 .../templates/ts_sketch_analyzer.jinja2       |  7 +++++-
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/docs/sources/user/Setting-Up-Virtualenv.md b/docs/sources/user/Setting-Up-Virtualenv.md
index 13aec11..105a710 100644
--- a/docs/sources/user/Setting-Up-Virtualenv.md
+++ b/docs/sources/user/Setting-Up-Virtualenv.md
@@ -68,3 +68,25 @@ To deactivate the virtualenv run:
 $ deactivate
 ```
 
+## Configuring Git Client
+
+Before submitting code to the project, make sure that you have created a fork of
+the l2tscaffolder project, and check out your personal fork:
+
+```
+$ git clone https://github.com/USERNAME/l2tscaffolder.git
+```
+
+Add the upstream repo:
+
+```
+$ git remote add upstream https://github.com/log2timeline/l2tscaffolder.git
+```
+
+And then you can create a feature branch to work on.
+
+```
+$ git checkout -b my_feature
+```
+
+
diff --git a/l2tscaffolder/templates/ts_sketch_analyzer.jinja2 b/l2tscaffolder/templates/ts_sketch_analyzer.jinja2
index ceabfee..d50227a 100644
--- a/l2tscaffolder/templates/ts_sketch_analyzer.jinja2
+++ b/l2tscaffolder/templates/ts_sketch_analyzer.jinja2
@@ -50,7 +50,7 @@ class {{ class_name }}SketchPlugin(interface.BaseSketchAnalyzer):
         # sketch.get_all_indices()
         # (If you add a view, please make sure the analyzer has results before
         # adding the view.)
-        # sketch.add_view(
+        # view = sketch.add_view(
         #     view_name=name, analyzer_name=self.NAME,
         #     query_string=query_string, query_filter={})
         # event.add_attributes({'foo': 'bar'})
@@ -62,6 +62,11 @@ class {{ class_name }}SketchPlugin(interface.BaseSketchAnalyzer):
         # event.add_human_readable('human readable text', self.NAME)
         # Remember you'll need to add event.commit() once all changes to the
         # event have been completed.
+        # You can also add a story.
+        # story = self.sketch.add_story(title='Story from analyzer')
+        # story.add_text('## This is a markdown title')
+        # story.add_view(view)
+        # story.add_text('This is another paragraph')
         for event in events:
             pass