Changing image sizes in readme. Spelling corrections

README.md

@@ -91,7 +91,7 @@ notebooklet with only 3 or 4 lines of code.
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/NBComparison.png"
 alt="Comparing a standard notebook with one using a notebooklet. The standard notebook on the left can require large amounts of code. The notebook on the right uses just 3 lines of code."
-title="With and without notebooklets" height="300" />
+title="With and without notebooklets" height="500" />
 
 
 ### Characteristics of Notebooklets
@@ -132,14 +132,14 @@ pip install msticnb
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/msticnb-import.png"
 alt="Python statement to import msticnb - 'import msticnb as nb'"
-title="Importing" height="300" />
+title="Importing" height="70" />
 
 The init method loads data drivers and data providers relevant to the
 the chosen data platform.
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/msticnb-init.png"
 alt="Python statement to initialize msticnb - nb.init('AzureSentinel')"
-title="Initializing msticnb" height="300" />
+title="Initializing msticnb" height="70" />
 
 ### Pick a notebooklet to use
 
@@ -153,7 +153,7 @@ sample code snippet for each.
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/msticnb-browser.png"
 alt="Notebooklet browser showing list of notebooklets and some details of the user documentation for the selected notebooklet."
-title="Notebooklet browser" height="300" />
+title="Notebooklet browser" height="500" />
 
 ### Instantiate the notebooklet and execute \"run\"
 
@@ -166,7 +166,7 @@ which to perform the operations.
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/msticnb-run-cell.png"
 alt="Python code cell showing the creation of a notebooklet instance from the WinHostevents notebooklet class. The notebooklet 'run' method is called with parameters supplying the name of the host and a time range."
-title="Running a notebooklet" height="300" />
+title="Running a notebooklet" height="100" />
 
 The notebooklet displays output directly to the notebook (although this
 can be suppressed) - showing text, data tables and visualizations. This
@@ -178,7 +178,7 @@ typing its name into and emtpy cell and running the cell.
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/msticnb-run.png"
 alt="The notebooklet displays output directly to th notebook. The output includes styled tables, text headings and descriptions and interactive timeline visualizations."
-title="Running a notebooklet" height="300" />
+title="Running a notebooklet" height="600" />
 
 ### View extended help for a notebooklet
 
@@ -193,7 +193,7 @@ shown earlier.
 
 <img src="https://github.com/microsoft/msticnb/blob/master/docs/source/_static/msticnb-help.png"
 alt="The notebooklet help displays a description, parameter and other usage information and available methods. It also describes the major output sections and the contents of the return results."
-title="Notebooklet help" height="300" />
+title="Notebooklet help" height="500" />
 
 ## Current Notebooklets
 

docs/source/creatingnotebooklets.rst

@@ -9,7 +9,7 @@ Notebooklets have two components:
 
 - A python module containing the code that does all of the processing
   work that you'd normally write directly into notebook cells.
-- A yaml file that contains configuration, documentation and text
+- A YAML file that contains configuration, documentation and text
   content that you want to display as part of your notebooklet's output.
 
 Custom notebooklets must be in a package of their own (although you
@@ -124,8 +124,8 @@ The first section of the the class definition contains the docstring.
 This documentation is used by the notebooklet browser and the
 show_help() function to provide extended user-friendly help.
 
-The first three lines of code handle assiging metadata and documentation
-data from the notebooklet yaml file (see below) so that the notebooklet
+The first three lines of code handle assigning metadata and documentation
+data from the notebooklet YAML file (see below) so that the notebooklet
 code can access it.
 
 .. warning:: Do not change these lines unless you know what you are doing.
@@ -201,7 +201,7 @@ The set_text decorator
 
 The ``@set_text`` decorator requires some explanation. This decorator
 gives you the ability to output display text every time ``run()`` is called.
-It references the _CELL_DOCS dictionary, which is read from the yaml metadata
+It references the _CELL_DOCS dictionary, which is read from the YAML metadata
 file, and specifies a key which is used to look up the exact section from the
 file to use.
 
@@ -224,7 +224,7 @@ The run method body
     )
 
 Calling the base class ``run`` method from your implementation is important.
-This does things like handle options and optionall convert and normalize the timespan
+This does things like handle options and convert and normalize the timespan
 parameter.
 
 The next section validates any input parameters that you require and creates
@@ -279,7 +279,7 @@ want to execute and in what order.
 You can call additional methods unconditionally or use the option logic to
 allow users to add additional operations or skip ones that they are not
 interested in. The available and default options for your notebooklet are defined in
-the notebooklet yaml file.
+the notebooklet YAML file.
 
 If you call run() without specifying the options parameter, the defaults will be
 used. You can specify a custom set of options as a list of option names (strings).
@@ -419,7 +419,7 @@ results class (shown earlier).
 Notebook YAML file
 ------------------
 
-The notebooklet yaml file should have the same name as the Python module but
+The notebooklet YAML file should have the same name as the Python module but
 with a "yaml" or "yml" extension.
 
 There are two main sections: ``metadata`` and ``output``.
@@ -459,7 +459,7 @@ include:
   that deal with hosts, IP addresses, etc.
 - req_providers - this is a list of data providers required for the notebooklet
   to run. You can provide alternates (as shown), which means that if one of the
-  providers is available the notebooklet will load succesfully.
+  providers is available the notebooklet will load successfully.
 
 
 .. code:: YAML

docs/source/index.rst

@@ -27,16 +27,14 @@ packaged analytics) will take a pandas DataFrame as input.
 
 .. code:: ipython3
 
-   import msticnb as nb
-   nb.init(query_provider="AzureSentinel")
    host_summary = nb.nblts.azsent.host.HostSummary()
    host_sum_rslt = host_summary.run(value="Msticalertswin1", timespan=time_span)
 
 
 You can create your own notebooklets and use them in the same framework
 as the ones already in the package.
 
-Read on to find out more about using and creating notebooks.
+Read on to find out more about using and creating notebooklets.
 
 
 Introduction and Usage

docs/source/notebooklets.rst

@@ -51,6 +51,7 @@ Why did we create notebooklets?
 
 Why aren't these part of msticpy?
 ---------------------------------
+
 - Msticpy aims to be platform-independent, whereas most if not all notebooklets
   assume a data schema that is specific to their data provider/SIEM.
 - Msticpy is mostly for discrete functions such as data acquisition, analysis
@@ -179,7 +180,7 @@ description and usage information (parameters, available methods, options).
 It also describes the major output sections that will be displayed and the
 the contents of the return results.
 
-.. note:: the contents of this help are also displayed in the noteboolet
+.. note:: the contents of this help are also displayed in the notebooklet
    browser shown earlier.
 
 .. figure:: _static/msticnb-help.png
@@ -204,7 +205,7 @@ Main operations:
   that you can use to pick the account.
 - Selecting the account displays a summary of recent activity and
   retrieves any alerts and hunting bookmarks related to the account
-- The alerts and bookmarks are browseable using the browse_alerts and
+- The alerts and bookmarks are browsable using the browse_alerts and
   browse_bookmarks methods
 - You can call the find_additional_data method to retrieve and display
   more detailed activity information for the account.
@@ -227,15 +228,11 @@ Host Logons Summary Notebooket class.
 
 Queries and displays information about logons to a host including:
 
--  Summary of sucessfull logons
-
+-  Summary of successful logons
 -  Visualizations of logon event times
-
 -  Geolocation of remote logon sources
-
 -  Visualizations of various logon elements depending on host type
-
--  Data on users with failed and sucessful logons
+-  Data on users with failed and successful logons
 
 
 
@@ -247,11 +244,8 @@ HostSummary Notebooklet class.
 Queries and displays information about a host including:
 
 -  IP address assignment
-
 -  Related alerts
-
 -  Related hunting/investigation bookmarks
-
 -  Azure subscription/resource data.
 
 
@@ -264,11 +258,8 @@ Windows host Security Events Notebooklet class.
 Queries and displays Windows Security Events including:
 
 -  All security events summary
-
 -  Extracting and displaying account management events
-
 -  Account management event timeline
-
 -  Optionally parsing packed event data into DataFrame columns
 
 Process (4688) and Account Logon (4624, 4625) are not included in the
@@ -285,13 +276,9 @@ Queries network data and plots time lines for network traffic to/from a
 host or IP address.
 
 -  Plot flows events by protocol and direction
-
 -  Plot flow count by protocol
-
 -  Display flow summary table
-
 -  Display flow summary by ASN
-
 -  Display results on map