Add some docs about architecture #459
Merged
a3thakra
merged 2 commits from adi-architecture-docs
into main
8 months ago
Loading…
Reference in new issue
There is no content yet.
Delete Branch 'adi-architecture-docs'
Deleting a branch is permanent. It CANNOT be undone. Continue?
#128
Cancelled CI because we don't need it.
The two main scripts that we have today are:
- `generate-calendar`: to generate an ical file that consumes events using the `/lib` folder - writing the resulting file to `public/events.ics`
- `optimize-images`: to optimize images present in the `images` folder and write the optimized images in the `public/images` folder for the website to consume
It might be nice to mention, either here or below, that the script also resizes images. (eg. "optimize-images: to resize and optimize images present in the
images
folder...")It could also be nice to mention that we have
npm run build:calendar
andnpm run build:images
to generate the calendar and optimize the images, respectively.npm run build:images
is particularly important, as none of the images will show up if you don't run it at least once.Though at this rate, I'm thinking I should write some separate docs with more details about image optimization... 🙃
I'll defer the first one to later when we create a doc for the optimize images script.
I can include the second one in there.
# Deploy
## Deploy
- `groups` (make sure you're in the `www` group)
I don't really know what groups are, I'm guessing this is groups that we can check on CEO and the solution is to contact syscom if someone is not in the group?
it's the linux
groups
commandThis is super helpful, thanks for taking to time to write it out!!
767e32511d
into main 8 months agoReviewers
767e32511d
.