Merge pull request #86 from intergral/docs_spellcheck

fic(docs): add spell check and fix typos in docs

docs/docs/_sections/expression.md

@@ -13,7 +13,7 @@ Python will evaluate the expressions using `eval` this allows you to execute any
 expressions. This allows for a lot of power to collect data, however it also allows for some potential bad scenarios.
 Where potentially harmful code can be executed. As a result we have tried to defend the user from some scenarios.
 
-- Global values are not exposed to eval
+- Global values are not exposed to `eval`
 
 ## Java
 

docs/docs/config/compaction.md

@@ -10,14 +10,14 @@ blocks that have to be scanned when performing a query.
 
 The compaction can be configured using the settings:
 
-| Name                      | Default | Description                                                                |
-|---------------------------|---------|----------------------------------------------------------------------------|
-| compaction_window         | 1h      | This is the maximum time range a block should contain.                     |
-| max_compaction_objects    | 6000000 | This is the maximum number of Snapshots that will be stored in each block. |
-| max_block_bytes           | 100 GiB | This is the maximum size in bytes that each block can be.                  |
-| block_retention           | 14d     | This is the total time a block will be stored for.                         |
-| compacted_block_retention | 1h      | This is the duration a compacted block will be stored for.                 |
-| compaction_cycle          | 1h      | The time between each compaction cycle.                                    |
+| Name                        | Default | Description                                                                |
+|-----------------------------|---------|----------------------------------------------------------------------------|
+| `compaction_window`         | 1h      | This is the maximum time range a block should contain.                     |
+| `max_compaction_objects`    | 6000000 | This is the maximum number of Snapshots that will be stored in each block. |
+| `max_block_bytes`           | 100 GiB | This is the maximum size in bytes that each block can be.                  |
+| `block_retention`           | 14d     | This is the total time a block will be stored for.                         |
+| `compacted_block_retention` | 1h      | This is the duration a compacted block will be stored for.                 |
+| `compaction_cycle`          | 1h      | The time between each compaction cycle.                                    |
 
 By modifying these settings you can control how often blocks are compacted, how big they should be and how much time
 they should span. There is no one size fits all config for compaction.

docs/docs/deploy/local.md

@@ -1,4 +1,4 @@
 # Deploy Locally
 
 The easiest way to evaluate DEEP and to test the features is to deploy the stack locally. To do this there a few
-examples using docker compose available in the [main repo](https://github.com/intergral/deep/tree/master/examples/docker-compose). 
+examples using docker compose available in the [main repository](https://github.com/intergral/deep/tree/master/examples/docker-compose). 

docs/docs/features/logging.md

@@ -1,7 +1,7 @@
 # Logging 
 Deep offers the ability to inject log messages into your running application to augment existing logging to add additional context when it is needed.
 
-To add a log message simply attach the argument 'log_msg' to the tracepoint.
+To add a log message simply attach the argument `log_msg` to the tracepoint.
 
 ```json
 {

docs/docs/features/method_entry.md

@@ -1,7 +1,7 @@
 # Method Entry
 
 This feature is linked to the [span features](./traces.md). Essentially this allows Deep to create snapshots or spans on
-methods rather than lines, by setting the argument 'method_name'.
+methods rather than lines, by setting the argument `method_name`.
 
 ```json
 {
@@ -13,6 +13,6 @@ methods rather than lines, by setting the argument 'method_name'.
 }
 ```
 
-This would essentially ignore the line number and instead create a snapshot when the method/function 'session_created'
-in the file 'some/file.py' is called. This can be useful if the line numbers of the running code is not known, but you
+This would essentially ignore the line number and instead create a snapshot when the method/function `session_created`
+in the file `some/file.py` is called. This can be useful if the line numbers of the running code is not known, but you
 know the method/function name. 

docs/docs/features/metrics.md

@@ -38,7 +38,7 @@ The specific supported providers is dependent on the client that is being used.
 using the plugin architecture of the client. As a generalisation the following providers will be detected and used automatically:
 
  - Prometheus
-- OpenTelemarty (OTel)
+- OpenTelemetry (OTel)
 
 For more info on what providers are supported by which clients see the client docs.
 
@@ -49,7 +49,7 @@ For more info on what providers are supported by which clients see the client do
 Let us imagine a scenario where we want to track when a user session is destroyed. Let us imagine the follow code is
 called when a user session is destroyed.
 
-```py title="users/session.py" linenums="22"
+```python title="users/session.py" linenums="22"
 def delete_session(self, user, session):
     self.process_session_end(session)
     session = self.db.delete_session(user.id)

docs/docs/features/tracepoints.md

@@ -4,8 +4,7 @@ Tracepoints are the way Deep defines the actions it will take. A tracepoint is p
 line number), however, there can also be other configurations that control how the data is collected and any
 restrictions the client should make.
 
-For details of the structure of a tracepoint see
-the [proto definition](https://github.com/intergral/deep-proto/blob/master/deepproto/proto/tracepoint/v1/tracepoint.proto).
+For details of the structure of a tracepoint see the [ProtoBuf definition](https://github.com/intergral/deep-proto/blob/master/deepproto/proto/tracepoint/v1/tracepoint.proto).
 
 ## Tracepoint Types
 

docs/docs/features/traces.md

@@ -1,7 +1,7 @@
 # Traces / Spans
 
 Deep offers the ability to dynamically create Spans at arbitrary points in the code. This allows you to augment your
-exising monitoring with specific Spans when you need additional data while diagnosing an issue.
+existing monitoring with specific Spans when you need additional data while diagnosing an issue.
 
 To create a Span the `span` argument should be attached to the tracepoint. This argument can have the values of:
 

docs/docs/getstarted.md

@@ -14,7 +14,7 @@ To follow this guide you will need to install:
 
 To start deep using the local docker stack follow these steps:
 
-1. Checkout the repo
+1. Checkout the repository
    ```bash
    git checkout https://github.com/intergral/deep.git
    ```
@@ -46,8 +46,8 @@ Now that we have deep running and a test app connected we want to see what we ca
 ![Tracepoint Create](./images/Explore_TracepointCreate.png)
 
 4. Here we can enter the file and line number to collect data. In this example we want to use:
-    - File Path: simple_test.py
-    - Line Number: 31
+    - File Path: `simple_test.py`
+    - Line Number: `31`
 
    Once set click 'Create Tracepoint' to create the tracepoint.
 7. If created successfully you will see the result in the query result below:

docs/docs/known_words.txt

@@ -0,0 +1,12 @@
+intergral
+tracepoint
+tracepoints
+datasource
+grafana
+ingester
+kubernetes
+config
+runtime
+nashorn
+lucee
+backend

docs/mkdocs.yml

@@ -40,3 +40,31 @@ plugins:
   - glightbox:
   - mkdocs_gitlinks:
       show_docs: true
+  - spellcheck:
+      backends: # the backends you want to use
+        - symspellpy  # as strings
+        - codespell: # or nested configs
+            dictionaries: [ clear, code, names ]
+
+      # known_words can also be a list of words
+      known_words: known_words.txt
+
+      # ignore words in <code> tags
+      ignore_code: yes
+
+      # minimum length of words to consider
+      min_length: 2
+
+      # maximum number of capital letters in a word
+      max_capital: 1
+
+      # keep unicode characters
+      allow_unicode: no
+
+      # skip files entirely
+      skip_files:
+        - credits.md
+        - coverage.md
+
+      # whether to only check in strict mode
+      strict_only: no

docs/requirements.txt

@@ -3,3 +3,4 @@ mkdocs-material
 mkdocs-glightbox
 mkdocs-gitlinks
 mkdocs-awesome-pages-plugin
+mkdocs-spellcheck[all]