Skip to content

Commit

Permalink
Fixed Typos
Browse files Browse the repository at this point in the history
  • Loading branch information
orpzs committed Sep 4, 2024
1 parent d878099 commit 3075ebc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Download Python: https://www.python.org/downloads/
ℹ️ **You can setup this solution with three approaches. Choose one based on your requirements:**
- **A)** Using [Jupyter Notebooks](#a-jupyter-notebook-based-approach) (For better view at what is happening at each stage of the solution)
- **B)** Using [CLI](#b-command-line-interface-cli-based-approach) (For ease of use and running with simple python commands, without the need to understand every step of the solution)
- **C)** Using [terrafrom deployment](#c-using-terraform-to-deploy-the-solution) including your backend APIs with UI
- **C)** Using [terraform deployment](#c-using-terraform-to-deploy-the-solution) including your backend APIs with UI


### A) Jupyter Notebook Based Approach
Expand Down Expand Up @@ -311,7 +311,7 @@ python opendataqna.py --help
The provided terraform streamlines the setup of this solution and serves as a blueprint for deployment. The script provides a one-click, one-time deployment option. However, it doesn't include CI/CD capabilities and is intended solely for initial setup.

> [!NOTE]
> Current version of the Terraform Google Cloud provider does not support deployment of a few resources, this soultion uses null_resource to create those resources using Google Cloud SDK.
> Current version of the Terraform Google Cloud provider does not support deployment of a few resources, this solution uses null_resource to create those resources using Google Cloud SDK.
Prior to executing terraform, ensure that the below mentioned steps have been completed.

Expand Down Expand Up @@ -359,7 +359,7 @@ sh ./scripts/deploy-all.sh
```
This script will perform the following steps:
1. **Run terraform scripts** - These terraform scripts will generate all the GCP resources and configurations files required for the frontend & backend. It will also generate embeddings and store it in the destination vector db.
1. **Run terraform scripts** - These terraform scripts will generate all the GCP resources and configuration files required for the frontend & backend. It will also generate embeddings and store it in the destination vector db.
1. **Deploy cloud run backend service with latest backend code** - The terraform in the previous step uses a dummy container image to deploy the initial version of cloud run service. This is the step where the actual backend code gets deployed.
1. **Deploy frontend app** - All the config files, web app etc required to create the frontend are deployed via terraform. However, the actual UI deployment takes place in this step.

Expand Down
3 changes: 2 additions & 1 deletion frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
1. Install the firebase tools to run CLI commands
```
cd Open_Data_QnA
gcloud services enable firebase.googleapis.com --project=$PROJECT_ID # Enable firebase management API
npm install -g firebase-tools
Expand Down Expand Up @@ -136,7 +138,6 @@
Run the below commands on the terminal
```
gcloud services enable firebase.googleapis.com --project=$PROJECT_ID # Enable firebase management API
cd Open_Data_QnA/frontend
```
Expand Down
8 changes: 4 additions & 4 deletions notebooks/1_Setup_OpenDataQnA.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -373,13 +373,13 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## ⚙️ **1.1 Database Setup for Vector Store: CloudSQL-pgvector**\n",
"## ⚙️ **1.1 Database Setup for Vector Store**\n",
"\n",
"Create PostgreSQL Instance on CloudSQL if 'cloudsql-pgvector' is chosen as vector store\n",
"If BigQuery is your vector store, the dataset is created.\n",
"\n",
"Note that a PostgreSQL Instance on CloudSQL already exists if 'cloudsql-pg' is the data source. PostgreSQL Instance is created only if a different data store is chosen.\n",
"If 'cloudsql-pgvector' is chosen as vector store, PostgreSQL Instance on CloudSQL (Note that this version of code supports only creating vector store on same instance as source)\n",
"\n",
"The cell will also create a dataset to store the log table on Big Query, **if** logging is enabled."
"The cell will also create a dataset to store the log table on Big Query, **if** logging is enabled if its not bigquery vector."
]
},
{
Expand Down

0 comments on commit 3075ebc

Please sign in to comment.