diff --git a/website/Makefile b/website/Makefile index 117b061c6..1c3aec3ac 100644 --- a/website/Makefile +++ b/website/Makefile @@ -22,4 +22,4 @@ publish: build sync: aws s3 sync /usr/src/website/dist/ s3://corsobackup.io/ --exclude ".git/*" --delete - aws cloudfront create-invalidation --distribution-id ESFSMEIU1TDEN --paths "/*" + aws cloudfront create-invalidation --distribution-id XXXXX --paths "/*" diff --git a/website/README.md b/website/README.md new file mode 100644 index 000000000..14b6c99f5 --- /dev/null +++ b/website/README.md @@ -0,0 +1,40 @@ +# Corso website documentation + +## Requirements + +Building the Corso website requires the following tools on your machine: + +- `make` +- Docker + +## Installation + +```bash +make buildimage +``` + +## Live documentation development + +```bash +make dev +``` + +This command starts a local development server within the Docker container and will expose a live website preview at [http://localhost:3000](http://localhost:3000). + +## Building a static website + +```bash +make build +``` + +This command generates static content into the `dist` directory for integration with any static contents hosting service. If you are using AWS S3 + CloudFront, you can run `make publish` to upload to the configured S3 bucket. + +## Website platform development + +```bash +make shell +``` + +Use this command to interactively (and temporarily!) change the contents or +configuration of the live website container image (for example, when +experimenting with new packages).