4b94c4f012
## Description This makes it so that we have an option to locally run all Makefile targets without having to go through Docker. That said, it retains Docker as the default way to run it, but now we can set an evn variable `CORSO_USE_DOCKER=-1` to skip running through docker. I understand if this looks a bit hacky and don't want to add it in, but thought I wold propose this anyways. While not major, I was able to get a good amount of decrease in build times. ## Type of change <!--- Please check the type of change your PR introduces: ---> - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [ ] 🗺️ Documentation - [ ] 🤖 Test - [x] 💻 CI/Deployment - [ ] 🐹 Trivial/Minor ## Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * #<issue> ## Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [ ] ⚡ Unit test - [ ] 💚 E2E
Corso website documentation
Requirements
Building the Corso website requires the following tools on your machine:
make- Docker
Installation
make buildimage
Live documentation development
make dev
This command starts a local development server within the Docker container and will expose a live website preview at http://localhost:3000.
Building a static website
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
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).