Add some docs about architecture #459

Merged
a3thakra merged 2 commits from adi-architecture-docs into main 2 months ago
Owner
#128
a3thakra added 1 commit 2 months ago
6bf9695dfc Add some docs about architecture
Poster
Owner

Cancelled CI because we don't need it.

Cancelled CI because we don't need it.
a258wang reviewed 2 months ago
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
Owner

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 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...")
Owner

It could also be nice to mention that we have npm run build:calendar and npm 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... 🙃

It could also be nice to mention that we have `npm run build:calendar` and `npm 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... 🙃
Poster
Owner

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.

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.
a3thakra marked this conversation as resolved
a3thakra added 1 commit 2 months ago
eca55f4e2b Address feedback
snedadah reviewed 2 months ago
# Deploy
## Deploy
- `groups` (make sure you're in the `www` group)
Collaborator

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?

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?
Poster
Owner

it's the linux groups command

it's the linux `groups` command
snedadah approved these changes 2 months ago
snedadah left a comment
Collaborator

This is super helpful, thanks for taking to time to write it out!!

This is super helpful, thanks for taking to time to write it out!!
a3thakra merged commit 767e32511d into main 2 months ago
a3thakra deleted branch adi-architecture-docs 2 months ago

Reviewers

snedadah approved these changes 2 months ago
continuous-integration/drone/push Build was killed
The pull request has been merged as 767e32511d.
Sign in to join this conversation.
No reviewers
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

Loading…
There is no content yet.