Milestone 2 README

[joulev]

https://test.joulev.dev/orbital/ms2-readme until this PR is merged. Or you can also spin up the Next.js server and go to /orbital/ms2-readme.

If we print this thing out it would be 22 pages, oh my goodness.

@VietAnh1010 Feel free to add anything you'd like to add. Also could you work on the slide content for the video? (no need to design the slides, just the content and transcript). The video in MS2 is drastically different so we can't reuse anything from past videos any more.

[codecov]

Codecov Report

Merging #143 (b2877c9) into main (5f42e45) will decrease coverage by 4.49%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #143      +/-   ##
==========================================
- Coverage   99.31%   94.81%   -4.50%     
==========================================
  Files          31       44      +13     
  Lines         435      868     +433     
  Branches      110      191      +81     
==========================================
+ Hits          432      823     +391     
- Misses          3       41      +38     
- Partials        0        4       +4     

Impacted Files	Coverage Δ
server/firebase/firebaseAdmin.ts	92.30% <0.00%> (ø)
server/utils/errors/customApiError.ts	100.00% <0.00%> (ø)
server/utils/testUtils.ts	83.07% <0.00%> (ø)
server/utils/crud/siteUtils.ts	98.61% <0.00%> (ø)
server/utils/crud/pageUtils.ts	98.66% <0.00%> (ø)
server/utils/firestoreUtils.ts	100.00% <0.00%> (ø)
server/firebase/firestoreCollections.ts	100.00% <0.00%> (ø)
client/lib/fetcher.ts	100.00% <0.00%> (ø)
client/lib/errors.ts	100.00% <0.00%> (ø)
server/utils/crud/userUtils.ts	100.00% <0.00%> (ø)
... and 3 more

[joulev]

Literal "self-review" to address the <Internal>'s. Commenting this way makes it easier to track.

[VietAnh1010]

Is there a way to disable CI-CD for this branch? CI-CD for this branch seems quite useless as we do not modify the code.

[joulev]

Is there a way to disable CI-CD for this branch? CI-CD for this branch seems quite useless as we do not modify the code.

There is, but I won't disable it. Useless as it may look like, this is how CI pipelines work: the code has to pass all the tests to be merged.

What if you put a wrong token to the MDX file, only for the build to fail?

You are not paying any money for this CI so you shouldn't worry :) (in fact, I am not paying any money for this either.)

[joulev]

If you don't have anything to add, feel free to merge.

[VietAnh1010]

I will probably review it another time.

You are not paying any money for this CI so you shouldn't worry :) (in fact, I am not paying any money for this either.)

Disable CI-CD for this will save some energy and reduce the amount of heat released into the environment :) Hopefully, this will slow down the heating of the Earth 🌏

[joulev]

Regarding CI/CD: this is a screenshot from simdjson/simdjson (15.8k stars so relatively very popular)

Our checks are minuscule compared to these 6+19+17+13 checks, so I won't entertain requests to remove CI/CD in the future even when it may be apparently unnecessary.