📖 Adding OLM V1 architecture document

[LalatenduMohanty]

The documentation contains description of the components and a diagram. Removed the components.md file as the architecture doc contains the same information

Fixes : #1124

Description

Reviewer Checklist

• API Go Documentation
• Tests: Unit Tests (and E2E Tests, if appropriate)
• Comprehensive Commit Messages
• Links to related GitHub Issue(s)

[netlify]

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	3433c16
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/66f2b6c08fb8550008abc119
😎 Deploy Preview	https://deploy-preview-1301--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.60%. Comparing base (62b5c53) to head (3433c16).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1301   +/-   ##
=======================================
  Coverage   76.60%   76.60%           
=======================================
  Files          40       40           
  Lines        2406     2406           
=======================================
  Hits         1843     1843           
  Misses        395      395           
  Partials      168      168           

Flag	Coverage Δ
e2e	58.14% <ø> (ø)
unit	53.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[perdasilva]

In general, I think it's really good. I've made a couple of suggestions and suggested edits. The suggested edits can also probably be improved. By hope they convey what I was thinking. I think we should also call out the CRs each component reconciles (with links to the API description).

[LalatenduMohanty]

I think we should also call out the CRs each component reconciles (with links to the API description).

@perdasilva I do not want to go to that low level in this document as it would impact the readability of the doc. We can have another doc (as follow up) which can talk about this. So that folks want to go little low level can move to those docs after going through the architecture doc.

[perdasilva]

I think we should also call out the CRs each component reconciles (with links to the API description).

@perdasilva I do not want to go to that low level in this document as it would impact the readability of the doc. We can have another doc (as follow up) which can talk about this. So that folks want to go little low level can move to those docs after going through the architecture doc.

I get that. I just would have expected the API the users use to not really be a low level thing. It's the front door XD

[LalatenduMohanty]

@perdasilva We already have #1230 and #1240.

So I am not entirely sure what you are looking for. If you can create an issue with more details/context I can take a look to fix it.