Merge pull request #1 from aws-samples/feature/add-document-explorer

feature: add document explorer sample

.github/dependabot.yml

@@ -7,20 +7,17 @@ updates:
       interval: "weekly"
     commit-message:
       prefix: "chore(deps): update github-actions versions"
-      include-commit-body: true
 
   - package-ecosystem: "terraform"
     directory: "/"
     schedule:
       interval: "weekly"
     commit-message:
       prefix: "chore(deps): update terraform modules"
-      include-commit-body: true
 
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
       interval: "weekly"
     commit-message:
       prefix: "chore(deps): update pip packages"
-      include-commit-body: true

.gitignore

@@ -0,0 +1,44 @@
+# Skip Visual Studio Code Workspace files
+*.code-workspace
+
+# No macOS files
+.DS_Store
+
+# Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version 
+# control as they are data points which are potentially sensitive and subject 
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Ignore transient lock info files created by terraform apply
+.terraform.tfstate.lock.info
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+

.terraform-version

@@ -0,0 +1 @@
+1.9.8

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]

CODE_OF_CONDUCT.md

@@ -1,4 +1,5 @@
-## Code of Conduct
+# Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
+[[email protected]](mailto:[email protected]) with any additional questions or comments.

CONTRIBUTING.md

@@ -6,7 +6,6 @@ documentation, we greatly value feedback and contributions from our community.
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
 information to effectively respond to your bug report or contribution.
 
-
 ## Reporting Bugs/Feature Requests
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
@@ -19,8 +18,8 @@ reported the issue. Please try to include as much information as you can. Detail
 * Any modifications you've made relevant to the bug
 * Anything unusual about your environment or deployment
 
-
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
 1. You are working against the latest source on the *main* branch.
@@ -39,20 +38,19 @@ To send us a pull request, please:
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
-
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
 
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
 
 ## Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
-
+[[email protected]](mailto:[email protected]) with any additional questions or comments.
 
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
 ## Licensing
 

LICENSE

@@ -1,4 +1,4 @@
-MIT No Attribution
+# MIT No Attribution
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
@@ -14,4 +14,3 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

README.md

@@ -1,17 +1,43 @@
-## My Project
+# AWS Generative AI Terraform Samples
 
-TODO: Fill this README out!
+This repository showcases Terraform examples to review and test AWS generative AI samples. The objective is to continue to add examples as new AWS Terraform modules are released. Once they are understood in depth, they can be used to extend on your own.
 
-Be sure to:
+<!-- Badges -->
 
-* Change the title in this README
-* Edit your repository description on GitHub
+## Getting started
 
-## Security
+Explore each self-contained sample to get started!
 
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+## Structure
+
+Each folder under the `samples` directory has a `README.md` with the specific instructions required to understand, execute, and cleanup the sample.
+
+```folder
+└── samples
+    ├── document-explorer               # Deploy a generative AI document explorer
+    │   ├── README.md                   # Instructions
+    │   ├── client_app                  # Steamlit application
+    │   │   └── Dockerfile              # Contain image (environmental variables updates required before frontend deploys)
+    │   ├── terraform-config-backend    # Backend Infrastructure
+    │   │   ├── main.tf                 # The main resources to be created (optional `solution_prefix`)
+    │   │   └── outputs.tf              # The outputs needed for the frontend (`Dockerfile`, and `terraform.tfvars`)
+    │   └── terraform-config-frontend   # Frontend Infrastructure
+    │       ├── main.tf                 # The main resources for the frontend (optional `app_name`)
+    │       ├── outputs.tf              # The outputs needed for accessing the cloud deployment (and second `Dockerfile` edit)
+    │       └── terraform.tfvars        # The variables from the backend to be entered
+    └── ...
+```
+
+## Issues, Support, Security, and Contributing
+
+Please add issues to this repository directly for the best support. This is a best effort repository and there is no expected SLA. In regards to security, please report it to [Security](mailto:[email protected]). If you are interested in contributiong, please fork the repository and submit a merge or pull request.
 
 ## License
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
+This library is licensed under the [MIT-0](https://github.com/aws/mit-0) License. See the LICENSE file.
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
 
+We hope you **Enjoy Exploring!**