🐛 Fix broken docs links

.gitignore

@@ -9,9 +9,7 @@ cmd/products/products
 cmd/frontend-host/frontend-host
 
 # Configs
-components/**
-!components/*.sample
-!components/readme.md
+components/*.yaml
 !components/pubsub.yaml
 !components/statestore.yaml
 

README.md

@@ -187,7 +187,7 @@ See `scripts/local-gateway` for details on how this is done, the `scripts/local-
 
 # Running in Kubernetes - Quick guide
 
-See [deploy/readme.md](deploy/readme.md)
+#### [📃 SUB-SECTION: Deployment guide for Kubernetes](./deploy/)
 
 # Running Locally - Quick guide
 
@@ -261,7 +261,7 @@ The default mode of operation for the Dapr Store is in "demo mode" where there i
 
 Optionally Dapr store can be configured utilise the [Microsoft identity platform](https://docs.microsoft.com/en-us/azure/active-directory/develop/) (aka Azure Active Directory v2) as an identity provider, to enable real user sign-in, and securing of the APIs.
 
-See the [security, identity & authentication docs](./docs/auth-identity.md) for more details on setting this up.
+#### [📃 SUB-SECTION: Full details on security, identity & authentication](./docs/auth-identity/)
 
 # Configuration
 
@@ -270,7 +270,7 @@ See the [security, identity & authentication docs](./docs/auth-identity.md) for
 The services support the following environmental variables. All settings are optional.
 
 - `PORT` - Port the server will listen on. See defaults below.
-- `AUTH_CLIENT_ID` - Used to enable integration with Azure AD for identity and authentication. Default is _blank_, which runs the service with no identity backend. See the [security, identity & authentication docs](./docs/auth-identity.md) for more details.
+- `AUTH_CLIENT_ID` - Used to enable integration with Azure AD for identity and authentication. Default is _blank_, which runs the service with no identity backend. See the [security, identity & authentication docs](#security-identity--authentication) for more details.
 - `DAPR_STORE_NAME` - Name of the Dapr state component to use. Default is `statestore`
 - `DAPR_ORDERS_TOPIC` - Name of the Dapr pub/sub topic to use for orders. Default is `orders-queue`
 - `DAPR_PUBSUB_NAME` - Name of the Dapr pub/sub component to use for orders. Default is `pubsub`
@@ -291,7 +291,7 @@ Frontend host config:
 
 ## Dapr Components
 
-See the [components documentation](components/) for full details of the Dapr components used by the application and how to configure them.
+#### [📃 SUB-SECTION: Details of the Dapr components used by the application and how to configure them.](components/)
 
 # Roadmap & known issues
 

_config.yml

@@ -5,10 +5,10 @@
 
 title: "Dapr Store: A Dapr Reference App"
 remote_theme: benc-uk/theme-msdark
-favicon: web/frontend/public/logo.png
+favicon: https://code.benco.io/dapr-store/web/frontend/public/logo.png
 plugins:
   - jemoji
 buttons:
   - b0:
     text: Main Guide
-    href: /
+    href: https://code.benco.io/dapr-store

components/readme.md

@@ -7,7 +7,7 @@ The application requires the follow Dapr components for operation:
 
 When working locally with Dapr these components with these names are deployed by default (i.e. when running `dapr init`), and backed by a Redis container, so no extra configuration or work is required.
 
-When deploying to Kubernetes the Redis state provider needs to stood up, Helm is an easy way to do this, see [deploy/readme.md](deploy/readme.md). The Dapr Store Helm chart then will install the relevant Dapr component definitions `statestore` and `pubsub` to use this Redis instance
+When deploying to Kubernetes the Redis state provider needs to stood up, Helm is an easy way to do this, see [deploy/readme.md](../deploy/readme.md). The Dapr Store Helm chart then will install the relevant Dapr component definitions `statestore` and `pubsub` to use this Redis instance
 
 ## Required Components
 

scripts/clear-redis.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 echo "🠶🠶🠶  WARNING! 💥 This will clear all Redis state"
-read -p "🠶🠶🠶  Press enter to continue, or ctrl-c to exit"
+read -r -p "🠶🠶🠶  Press enter to continue, or ctrl-c to exit"
 
 docker info > /dev/null 2>&1 || { echo "Docker is not running!"; exit 1; }
 

scripts/create-products-db.sh

@@ -9,10 +9,10 @@ inputCsv=${2:-"etc/products.csv"}
 
 echo "🠶🠶🠶 Will create or update: $outputDb"
 echo "🠶🠶🠶 Droping products table"
-sqlite3 $outputDb "DROP TABLE IF EXISTS products"
+sqlite3 "$outputDb" "DROP TABLE IF EXISTS products"
 
 echo "🠶🠶🠶 Creating products table"
-sqlite3 $outputDb "CREATE TABLE products ( 
+sqlite3 "$outputDb" "CREATE TABLE products ( 
   id TEXT not null primary key,
   name text NOT null,
   description TEXT,
@@ -21,6 +21,6 @@ sqlite3 $outputDb "CREATE TABLE products (
   onoffer INT);"
 
 echo "🠶🠶🠶 Importing $inputCsv into products table"
-sqlite3 -csv $outputDb ".import $inputCsv products"
+sqlite3 -csv "$outputDb" ".import $inputCsv products"
 
-echo "🠶🠶🠶 Database products table contains: $(sqlite3 $outputDb 'SELECT COUNT(*) FROM products;') products"
+echo "🠶🠶🠶 Database products table contains: $(sqlite3 "$outputDb" 'SELECT COUNT(*) FROM products;') products"