Restructure the getting started guide (nv-morpheus#536)

* Includes changes from PRs nv-morpheus#522 & nv-morpheus#534
* Moves `docs/source/basics/examples.rst` into `examples/basic_usage` and reformat as markdown. This avoids the issue of having two "examples" in the table of contents.
* Update remaining references to the quickstart guide with "cloud deployment".
* Create Parallel `index.rst` for the developer guides and examples, as markdown doesn't have the equivalent of the `toctree` macro.
* Restructure `docs/source/getting_started.md` making it clear which steps are and are not needed when using pre-built containers.
* Highlight the examples from top-level docs

relates to issue nv-morpheus#495

Authors:
  - David Gardner (https://github.com/dagardner-nv)
  - https://github.com/bsuryadev
  - Bhargav Suryadevara (https://github.com/bsuryadevara)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: nv-morpheus#536

.gitattributes

@@ -3,4 +3,4 @@ examples/data/** filter=lfs diff=lfs merge=lfs -text
 morpheus/_version.py export-subst
 tests/mock_triton_server/payloads/** filter=lfs diff=lfs merge=lfs -text
 tests/tests_data/** filter=lfs diff=lfs merge=lfs -text
-docs/source/basics/img/** filter=lfs diff=lfs merge=lfs -text
+examples/basic_usage/img/** filter=lfs diff=lfs merge=lfs -text

CONTRIBUTING.md

@@ -59,7 +59,7 @@ Once you have gotten your feet wet and are more comfortable with the code, you c
 
 Look at the unassigned issues, and find an issue to which you are comfortable contributing. Start with _Step 2_ above, commenting on the issue to let others know you are working on it. If you have any questions related to the implementation of the issue, ask them in the issue instead of the PR.
 
-## Setting Up Your Build Environment
+## Building from Source
 
 The following instructions are for developers who are getting started with the Morpheus repository. The Morpheus development environment is flexible (Docker, Conda and bare metal workflows) but has a high number of dependencies that can be difficult to setup. These instructions outline the steps for setting up a development environment inside a Docker container or on a host machine with Conda.
 

README.md

@@ -22,9 +22,10 @@ limitations under the License.
 NVIDIA Morpheus is an open AI application framework that provides cybersecurity developers with a highly optimized AI framework and pre-trained AI capabilities that allow them to instantaneously inspect all IP traffic across their data center fabric. The Morpheus developer framework allows teams to build their own optimized pipelines that address cybersecurity and information security use cases. Bringing a new level of security to data centers, Morpheus provides development capabilities around dynamic protection, real-time telemetry, adaptive policies, and cyber defenses for detecting and remediating cybersecurity threats.
 
 ## Documentation
-* [Getting Started with Morpheus](./docs/source/getting_started.md) - Using pre-built Docker containers, building from source, and fetching models and datasets
+* [Getting Started with Morpheus](./docs/source/getting_started.md) - Using pre-built Docker containers, building Docker containers from source, and fetching models and datasets
+* [Morpheus Examples](./examples.md) - Example pipelines using both the Python API and command line interface
 * [Developer Guides](./docs/source/developer_guide/guides.md) - Covers extending Morpheus with custom stages
-* [Deployment Guide](./docs/source/morpheus_quickstart_guide.md) - Kubernetes and cloud based deployments
-* [Contributing to Morpheus](./CONTRIBUTING.md) - Covers making changes and contributing to Morpheus
+* [Deployment Guide](./docs/source/cloud_deployment_guide.md) - Kubernetes and cloud based deployments
+* [Contributing to Morpheus](./CONTRIBUTING.md) - Covers building from source, making changes and contributing to Morpheus
 
 Full documentation for the latest official release is available at [https://docs.nvidia.com/morpheus/](https://docs.nvidia.com/morpheus/).

docs/source/cloud_deployment_guide.md

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-# Morpheus Quickstart Guide
+# Morpheus Cloud Deployment Guide
 
 ## Table of Contents
 - [Introduction](#introduction)

docs/source/developer_guide/guides.md

@@ -19,8 +19,8 @@ limitations under the License.
 
 Morpheus includes several stages to choose from when building a custom pipeline, which can be included and configured to suit your needs. However, there are likely going to be situations that require writing a custom stage. Morpheus stages are written in Python and optionally may include a C++ implementation. The following guides outline how to create your own stages in both Python and C++.
 
-## [Simple Python Stage](./guides/1_simple_python_stage.md)
-## [Real-World Application: Phishing Detection](./guides/2_real_world_phishing.md)
-## [Simple C++ Stage](./guides/3_simple_cpp_stage.md).
-## [Creating a C++ Source Stage](./guides/4_source_cpp_stage.md).
-## [Digital Fingerprinting (DFP)](./guides/5_digital_fingerprinting.md).
+* [Simple Python Stage](./guides/1_simple_python_stage.md)
+* [Real-World Application: Phishing Detection](./guides/2_real_world_phishing.md)
+* [Simple C++ Stage](./guides/3_simple_cpp_stage.md).
+* [Creating a C++ Source Stage](./guides/4_source_cpp_stage.md).
+* [Digital Fingerprinting (DFP)](./guides/5_digital_fingerprinting.md).

docs/source/developer_guide/guides/index.rst

@@ -0,0 +1,12 @@
+======
+Guides
+======
+
+.. toctree::
+   :maxdepth: 20
+
+   ./1_simple_python_stage.md
+   ./2_real_world_phishing.md
+   ./3_simple_cpp_stage.md
+   ./4_source_cpp_stage.md
+   ./5_digital_fingerprinting.md

docs/source/examples.md

@@ -0,0 +1,27 @@
+<!--
+SPDX-FileCopyrightText: Copyright (c) 2022, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+SPDX-License-Identifier: Apache-2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Examples
+* [Basic CLI Usage](./examples/basic_usage/README.md)
+* [Anomalous Behavior Profiling with Forest Inference Library (FIL) Example](./examples/abp_nvsmi_detection/README.md)
+* [ABP Detection Example Using Morpheus](./examples/abp_pcap_detection/README.md)
+* [GNN Fraud Detection Pipeline](./examples/gnn_fraud_detection_pipeline/README.md)
+* [Example cyBERT Morpheus Pipeline for Apache Log Parsing](./examples/log_parsing/README.md)
+* [Sensitive Information Detection with Natural Language Processing (NLP) Example](./examples/nlp_si_detection/README.md)
+* [Example Ransomware Detection Morpheus Pipeline for AppShield Data](./examples/ransomware_detection/README.md)
+* [Root Cause Analysis Acceleration & Predictive Maintenance Example](./examples/root_cause_analysis/README.md)
+* [SID Visualization Example](./examples/sid_visualization/README.md)

docs/source/examples/abp_nvsmi_detection/README.md

@@ -0,0 +1 @@
+../../../../examples/abp_nvsmi_detection/README.md

docs/source/examples/abp_nvsmi_detection/pipeline.png

@@ -0,0 +1 @@
+../../../../examples/abp_nvsmi_detection/pipeline.png

docs/source/examples/abp_pcap_detection/README.md

@@ -0,0 +1 @@
+../../../../examples/abp_pcap_detection/README.md

docs/source/examples/basic_usage/README.md

@@ -0,0 +1 @@
+../../../../examples/basic_usage/README.md

docs/source/examples/basic_usage/img

@@ -0,0 +1 @@
+../../../../examples/basic_usage/img

docs/source/examples/gnn_fraud_detection_pipeline/README.md

@@ -0,0 +1 @@
+../../../../examples/gnn_fraud_detection_pipeline/README.md

docs/source/developer_guide/examples/index.rst → docs/source/examples/index.rst

@@ -5,6 +5,7 @@ Examples
 .. toctree::
    :maxdepth: 20
 
+   basic_usage/README.md
    abp_nvsmi_detection/README.md
    abp_pcap_detection/README.md
    gnn_fraud_detection_pipeline/README.md

docs/source/examples/log_parsing/README.md

@@ -0,0 +1 @@
+../../../../examples/log_parsing/README.md

docs/source/examples/nlp_si_detection/README.md

@@ -0,0 +1 @@
+../../../../examples/nlp_si_detection/README.md

docs/source/examples/nlp_si_detection/pipeline.png

@@ -0,0 +1 @@
+../../../../examples/nlp_si_detection/pipeline.png

docs/source/examples/ransomware_detection/README.md

@@ -0,0 +1 @@
+../../../../examples/ransomware_detection/README.md

docs/source/examples/root_cause_analysis/README.md

@@ -0,0 +1 @@
+../../../../examples/root_cause_analysis/README.md

docs/source/examples/sid_visualization/README.md

@@ -0,0 +1 @@
+../../../../examples/sid_visualization/README.md