Documentation (#222)

Azure · Oct 10, 2024 · fee90ed · fee90ed
1 parent ebed54b
commit fee90ed
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 30 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -112,11 +112,22 @@ nav:
   - Concepts:
     - index.md
     - getting_started.md
+  - Design:
+    - design_architecture.md
+    - design_infrastructure.md
+    - design_software.md
+  - Services:
+    - services_overview.md
+    - services_source.md
+    - OSDU:
+      - services_core.md
+      - services_reference.md
+    - Experimental:
+      - experimental_adminui.md
+  - Features:
     - feature_flags.md
-    - Design:
-      - design_architecture.md
-      - design_infrastructure.md
-      - design_software.md
+  - Installation:
+    - install_prerequisites.md
   - Tutorials:
     - Deployment:
       - tutorial_cli.md
@@ -128,11 +139,4 @@ nav:
       - debugging_kibana.md
     - Advanced Scenarios:
       - advanced_vnet.md
-  - Services:
-    - services_overview.md
-    - services_source.md
-    - OSDU:
-      - services_core.md
-      - services_reference.md
-    - Experimental:
-      - experimental_adminui.md
+
diff --git a/docs/src/feature_flags.md b/docs/src/feature_flags.md
@@ -1,4 +1,4 @@
-# Feature Flags
+# Configuration Flags
 
 Feature flags are configuration settings used to modify the default behavior of an OSDU™ personal instance.
 

diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md
@@ -2,23 +2,6 @@
 
 Prerequisites and configuration steps for deploying personal OSDU™ instances in an Azure Subscription.
 
-
-## Software Tools
-
-!!! tip "Install Required Software"
-    Install the following software locally.
-
-| Software | Description | Download Link |
-|----------|-------------|---------------|
-| Visual Studio Code | Code editor with REST Client Extension | [Download](https://code.visualstudio.com/download) |
-| PowerShell Core | Cross-platform task automation solution | [Download](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4) |
-| Azure CLI | Command-line tool for managing Azure resources | [Download](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) |
-| Azure Developer CLI | Command-line tool for Azure development | [Download](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) |
-
-!!! note "Visual Studio Code Extension"
-    After installing Visual Studio Code, make sure to install the [REST Client Extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
-
-
 ## Subscription Quota
 
 It is recommended to have at least 50 vCPUs in a region along with the ability to deploy Cosmos DB instances which can be resource constrained in some regions.  Defaults for MSDN accounts can be increased by requesting a [quota increase](https://learn.microsoft.com/en-us/azure/quotas/regional-quota-requests).

diff --git a/docs/src/install_prerequisites.md b/docs/src/install_prerequisites.md
@@ -0,0 +1,53 @@
+# Prerequisites
+
+This guide outlines the software tools you need installed locally to work with the solution. 
+
+#### Operating System Support
+
+<div class="grid cards" markdown>
+
+-   :fontawesome-brands-apple:{ .lg .middle } __macOS__
+
+-   :fontawesome-brands-linux:{ .lg .middle } __Linux__
+
+-   :fontawesome-brands-windows:{ .lg .middle } __Windows__
+
+</div>
+
+??? info "Audience"
+    :fontawesome-solid-code:{ .lg .middle } __Application Developer__: Working with Services and Applications
+
+    :fontawesome-solid-cloud:{ .lg .middle } __Cloud Architects__: Working with Infrastructure and Software
+
+
+### Visual Studio Code
+Visual Studio Code is a lightweight but powerful source code editor. Install it along with the REST Client Extension for testing and interacting with REST APIs.
+
+[Download Visual Studio Code](https://code.visualstudio.com/download)
+
+### PowerShell Core
+PowerShell Core is a cross-platform task automation solution, useful for scripting and automation tasks in our solution.
+
+[Download PowerShell Core](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)
+
+### Azure CLI
+The Azure Command-Line Interface (CLI) is a set of commands used to create and manage Azure resources. It's essential for managing your Azure environment.
+
+[Download Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
+
+### Azure Developer CLI
+The Azure Developer CLI (azd) is a command-line tool designed to accelerate the time it takes to get started on Azure. It's particularly useful for Azure development tasks.
+
+[Download Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd)
+
+### Visual Studio Code Extensions
+
+After installing Visual Studio Code, please install the following extensions to enahnce your development experience with working with this solution.
+
+| Name | Recommendation | Description |
+|------|----------------|-------------|
+| [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) | Required | Allows you to send HTTP requests and view responses directly within VS Code |
+| [Bicep](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) | Required | Provides language support for Bicep, a domain-specific language for deploying Azure resources |
+| [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) | Optional | Adds rich support for the Python language, including features like IntelliSense and debugging |
+| [Java Extension Pack](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) | Optional | A collection of popular extensions for Java development in VS Code |
+