Skip to content

Update README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joeriddles merged 1 commit into from
Mar 14, 2022
Merged

Update README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"markdown.extension.toc.slugifyMode": "github"
}
36 changes: 31 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
# Stan's Static Site
# Stan's Static Site <!-- omit in toc -->
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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down