chore: added docs link

IamShobe · Sep 14, 2024 · 00b3016 · 00b3016
1 parent 6091ed6
commit 00b3016
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 3 deletions.
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -1,4 +1,4 @@
-name: ci 
+name: deploy docs 
 on:
   push:
     branches:
@@ -8,7 +8,7 @@ permissions:
   contents: write
 
 jobs:
-  deploy:
+  deploy-docs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

diff --git a/README.md b/README.md
@@ -12,6 +12,10 @@ Those backends were problematic for me because I had issues trusting them to sto
 The closest solution I found was [terraform-backend-git](https://github.com/plumber-cd/terraform-backend-git) - which this project was heavily influenced on - so go check it out as well!  
 Eventually I had the idea of creating an **extendable modular terraform http backend** - which allows customizing the state using `transformations` (like encryption), and getting starting with it will be as simple as running single command.
 
+## Documentation
+
+Check out documentations here: [docs](https://terraflex.iamshobe.com)
+
 ## Installation
 Recommended apporach is using [pipx](https://github.com/pypa/pipx):
 ```bash

diff --git a/docs/gettings-started/intro.md b/docs/gettings-started/intro.md
@@ -1 +1,3 @@
 # Intro
+
+WIP
diff --git a/docs/gettings-started/storage-providers/envvar.md b/docs/gettings-started/storage-providers/envvar.md
@@ -3,3 +3,5 @@ tags:
   - Readable Storage
 ---
 # EnvVar
+
+WIP
diff --git a/docs/gettings-started/storage-providers/git.md b/docs/gettings-started/storage-providers/git.md
@@ -5,3 +5,5 @@ tags:
   - Lockable Storage
 ---
 # Git
+
+WIP
diff --git a/docs/gettings-started/storage-providers/local.md b/docs/gettings-started/storage-providers/local.md
@@ -5,3 +5,5 @@ tags:
   - Lockable Storage
 ---
 # Local
+
+WIP
diff --git a/docs/gettings-started/storage-providers/onepassword.md b/docs/gettings-started/storage-providers/onepassword.md
@@ -3,3 +3,5 @@ tags:
   - Readable Storage
 ---
 # 1Password
+
+WIP
diff --git a/docs/gettings-started/transformers/encryption.md b/docs/gettings-started/transformers/encryption.md
@@ -1 +1,3 @@
 # Encryption
+
+WIP
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,7 +25,7 @@ repo_name: IamShobe/terraflex
 edit_uri: edit/main/docs/
 
 nav:
-  - Home: 
+  - Terraflex: 
     - index.md
   - Getting Started: 
     - gettings-started/intro.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,5 @@ tags: @@
       - Readable Storage
     ---
     # EnvVar
+    WIP