Added Initial Draft of Readme, Removed Unnecessary Directories

Author: lmfarley10

.gitignore

@@ -100,33 +100,6 @@ clientApp/autoprompt/semantic_suggest_runbook.md
 # File with reference to orahub repo 
 deployment-docs/mkdocs.yml
 
-# Reference to api gateway
-# deployment-docs/docs/deployment/adw_private.md # cleaned up sensitive info
-
-# Reference to idcs discovery url 
-#deployment-docs/docs/deployment/business_api_gateway.md # cleaned up/masked sensitive data
-
-# Reference to oda instance 
-# deployment-docs/docs/deployment/business_idcs.md # cleaned/masked data
-
-# Reference to oracle redis 
-# deployment-docs/docs/deployment/nl2sql_engine.md # removed sensitive data. There are a lot of references to websocket... maybe we can remove this in the near future
-
-# Reference to API GW url 
-# deployment-docs/docs/deployment/oda.md  # masked sensitive data 
-
-# Reference to OCI tenancy 
-# deployment-docs/docs/deployment/trust-service.c.md # cleaned sensitive data. There are a couple references to artifactory here
-# deployment-docs/docs/deployment/trust-service.md # cleaned
-
-# Reference to IDCS/API GW 
-# deployment-docs/docs/deployment/trust-ui.md 
-# deployment-docs/docs/deployment/validation.md # cleaned
-# deployment-docs/docs/deployment/VBCS.md # masked
-
-# ips 
-# /deployment-docs/docs/rest/nl2sql-trust/installation.md # masked ips 
-
 # Reference to OCIDs 
 /deployment-docs/Finetune-DAC/finetune-dac-python.py
 
@@ -155,7 +128,7 @@ deployment-docs/mkdocs.yml
 
 # Adding entire rest trust directory for now, since there's a dependency on dotmap 
 # can maybe add delta review for next release
-/rest/
+rest/
 
 # Random IPs 
 /rest/nl2sql-trust/conf/dev_trust_config.json 
@@ -263,6 +236,14 @@ deployment-docs/mkdocs.yml
 # tenancy namespace 
 /scripts/oci 
 
+# Hiding terraform for now
+terraform/ 
+
+# Hiding sqlGenApp (used for finetuning) 
+sqlGenApp/ 
+
+scripts/
+
 # Reference to tenancy 
 /terraform/cloud-init/nl_engine_cloud_init.yml
 terraform/cloud-init/trust-cloud-init.yml

.ignore

@@ -1,20 +1,56 @@
-# TITLE
+# AskData NL2SQL Engine
 
 [![License: UPL](https://img.shields.io/badge/license-UPL-green)](https://img.shields.io/badge/license-UPL-green) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=oracle-devrel_test)](https://sonarcloud.io/dashboard?id=oracle-devrel_test)
 
-## THIS IS A NEW, BLANK REPO THAT IS NOT READY FOR USE YET.  PLEASE CHECK BACK SOON!
-
 ## Introduction
-MISSING
+
+[Introduction](deployment-docs/docs/deployment/introduction.md)
 
 ## Getting Started
-MISSING
+Start with familiarizing yourself with the [Architecture](deployment-docs/docs/deployment/architecture.md) & [Introduction](deployment-docs/docs/deployment/introduction.md)
+
+For policies see [Defining Policies](deployment-docs/docs/deployment/generic.md)
+
+The CIS Landing Zone is optional but helps with providing a sandbox environment with best practices
+[Deploy CIS LZ](deployment-docs/docs/deployment/landing_zone.md)
 
 ### Prerequisites
-MISSING
+This solution assumes you have access to an OCI tenancy with the admin ability to provision the following resources: 
+- VBCS 
+    - [Deploy VBCS](deployment-docs/docs/deployment/VBCS.md)
+- ODA
+    - [Deploy ODA](deployment-docs/docs/deployment/oda.md)
+- IAM Confidential App 
+    - [Deploy IAM App](deployment-docs/docs/deployment/business_idcs.md)
+- Vault
+    - [Deploy Vault](deployment-docs/docs/deployment/vault.md)
+- API Gateway
+    - [Deploy API Gateway](deployment-docs/docs/deployment/business_api_gateway.md)
+- Business (client) ADW database
+    - [Deploy Database](deployment-docs/docs/deployment/database.md)
+- Trust ADB database
+    - [Deploy Database](deployment-docs/docs/deployment/database.md)
+- Redis Cache 
+- VCN 
+    - Two VMs, one for engine in private sn and one bastion/jump host 
+        - [Deploy Engine Documentation](deployment-docs/docs/deployment/nl2sql_engine.md)
+
+## Deployment Steps
+
+1. Configure Business App
+    - Configure Business DB
+    - Configure Trust DB
+2. Configure IDCS App
+3. Configure API Gateway
+4. Configure ODA Skills
+5. Configure VB Apps 
 
 ## Notes/Issues
-MISSING
+
+See [Troubleshooting](deployment-docs/docs/deployment/architecture.md)
+
+This first release is focused on deploying the NL Engine/ClientApp for the business user. The Trust Framework plans to be added next release. However, documentation is available under [Deployment](deployment-docs/docs/deployment/)
+if you'd like to get familiar. All documentation related to apex & trust service would be for the trust framework. 
 
 ## URLs
 * Nothing at this time