R7 Docs Updates (Velocidex#711)

Added references to Rapid7 documentation for Velociraptor hosted in the Insight Platform. Also corrected Hugo website builder URL in the readme --------- Co-authored-by: Mike Cohen <[email protected]>
Director-Fusion · Oct 24, 2023 · 1d48b77 · 1d48b77
1 parent adb5bb5
commit 1d48b77
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 public/
 .wordlist.dict
 .hugo_build.lock
+.idea
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -1410,3 +1410,6 @@ extensibility
 masse
 transformative
 Uncompress
+
+# content/docs/_index.md
+InsightIDR
diff --git a/README.md b/README.md
@@ -4,14 +4,14 @@ This is the documentation site for Velociraptor - digging deeper!
 
 ## Building this site
 
-The site uses the static website generator [Hugo](https://hugo.io). 
+The site uses the static website generator [Hugo](https://gohugo.io).
 
 To develop on the site:
 1. clone this repository by running the following git clone command
    ```
    git clone --recurse-submodules https://github.com/Velocidex/velociraptor-docs.git
    ```
-    **Note** normal cloning will not work. You must recurse the submodules or hugo will not understand shortcodes and you will see errors such as: 
+    **Note** normal cloning will not work. You must recurse the submodules or hugo will not understand shortcodes and you will see errors such as:
   `failed to extract shortcode: template for shortcode "children" not found`
 
 2. Run Hugo:
@@ -24,9 +24,9 @@ To develop on the site:
    ```
    docker run --rm -it -v $(pwd):/src -p 1313:1313 klakegg/hugo:alpine server
    ```
-   
+
 3. Open your browser to http://localhost:1313.
-   
+
    This will bring up a local web server where you can see your changes.
 
 

diff --git a/config.yaml b/config.yaml
@@ -50,6 +50,9 @@ menu:
       identifier: "rss"
       url: "/rss/"
       weight: 40
+   -  name: "<i class='fa fa-question-circle'></i>Rapid7 Docs"
+      url: "https://docs.rapid7.com/"
+      weight: 50
 
 googleAnalytics: G-QYH72LMYCS
 

diff --git a/content/docs/_index.md b/content/docs/_index.md
@@ -22,3 +22,9 @@ used in many different situations, visit our
 Finally check out the Velociraptor [Blog]({{< ref "/blog" >}}) for articles about
 using Velociraptor in different scenarios and to learn more about
 Velociraptor's features.
+
+{{% notice note "Using Velociraptor integrated with Rapid7 InsightIDR?"%}}
+
+Read the [InsightIDR documentation](https://docs.rapid7.com/insightidr/velociraptor-alerts) to learn more about how Velociraptor and InsightIDR work together.
+
+{{% /notice %}}
diff --git a/content/docs/deployment/_index.md b/content/docs/deployment/_index.md
@@ -11,6 +11,12 @@ Signed]({{< relref "self-signed" >}}) or [Cloud Deployment]({{< relref
 local machine for testing environment. For more information, see
 [Instant Velociraptor](#instant-velociraptor).
 
+{{% notice note "Using Velociraptor integrated with Rapid7 InsightIDR?"%}}
+
+These deployment steps apply to open source Velociraptor only. Read the  [InsightIDR documentation](https://docs.rapid7.com/insightidr/velociraptor-integration) to learn more about how Velociraptor is deployed with the Insight Platform.
+
+{{% /notice %}}
+
 ## Deployment Overview
 
 Below is a typical Velociraptor deployment
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,4 @@ @@
     public/
     .wordlist.dict
     .hugo_build.lock
+    .idea