From 9a29654eef4713c1d0525a834ad7eefb7c0a3ab6 Mon Sep 17 00:00:00 2001 From: Joseph Riddle Date: Mon, 14 Mar 2022 16:50:03 -0700 Subject: [PATCH] Update README --- .vscode/settings.json | 3 +++ README.md | 36 +++++++++++++++++++++++++++++++----- 2 files changed, 34 insertions(+), 5 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9aa8441 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "markdown.extension.toc.slugifyMode": "github" +} diff --git a/README.md b/README.md index be8117c..e77d7c7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ -# Stan's Static Site +# Stan's Static Site A static website about Stan the Snakes's adventures created using Python's MkDocs +- [TODO](#todo) +- [Getting Started](#getting-started) + - [Create virtual environment](#create-virtual-environment) + - [Activate virtual environment](#activate-virtual-environment) + - [Install dependencies](#install-dependencies) + - [Debug site](#debug-site) + - [Build site](#build-site) +- [Azure](#azure) + - [Azure blob storage static website](#azure-blob-storage-static-website) + - [Resources](#resources) + - [OIDC](#oidc) + - [Resources](#resources-1) +- [AWS S3 Hosting](#aws-s3-hosting) + - [Troubleshooting](#troubleshooting) + - [For more indepth Python + AWS see Python on AWS - *Stan approved*](#for-more-indepth-python--aws-see-python-on-aws---stan-approved) + ## TODO - [x] Add MkDocs site - [ ] Write blog posts for @@ -50,7 +66,7 @@ mkdocs build ## Azure -Azure blob storage static website +### Azure blob storage static website ```powershell # create resource group az group create --name spug --location westus2 @@ -82,10 +98,20 @@ az storage account update -g spug --name stansstaticstorage --custom-domain "blo [https://blob.stansadventures.com/](https://blob.stansadventures.com/) -Resource +#### Resources - [Host a static website on Blob Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website-host) - - [Map a custom domain to an Azure Blob Storage endpoint](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-custom-domain-name?tabs=azure-cli#map-a-custom-domain-with-https-enabled) - - [Integrate a static website with Azure CDN](https://docs.microsoft.com/en-us/azure/storage/blobs/static-website-content-delivery-network) +- [Map a custom domain to an Azure Blob Storage endpoint](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-custom-domain-name?tabs=azure-cli#map-a-custom-domain-with-https-enabled) +- [Integrate a static website with Azure CDN](https://docs.microsoft.com/en-us/azure/storage/blobs/static-website-content-delivery-network) + +### OIDC +```powershell +# create Azure AD + +# create managed identity +``` + +#### Resources +- [Use GitHub Actions to connect to Azure](https://docs.microsoft.com/en-us/azure/developer/github/connect-from-azure) ## AWS S3 Hosting - Use the following user guide to setup a simple s3 bucket to host a static website