Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Overall architecture documentation #1124

Closed
3 tasks
Tracked by #959
perdasilva opened this issue Aug 14, 2024 · 3 comments · Fixed by #1301
Closed
3 tasks
Tracked by #959

Docs: Overall architecture documentation #1124

perdasilva opened this issue Aug 14, 2024 · 3 comments · Fixed by #1301
Assignees
@LalatenduMohanty
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Milestone
v1.0.0

Comments

@perdasilva
Copy link
Contributor

perdasilva commented Aug 14, 2024 •
edited
Loading

As part of our reference documentation, we need an OLMv1 architecture diagram

  • Documentation explaining the architecture
  • Architecture Diagram (CatD + O-C, watch directions, catd https endpoint)
  • Reviewed and signed-off by @joelanford

Would be nifty is the architecture diagram could provide links (mermaid might support this functionality)

Current documentation is posted up at https://operator-framework.github.io/operator-controller/
New docs should be placed in docs/drafts
@perdasilva perdasilva mentioned this issue Aug 14, 2024
Closed
14 tasks
@perdasilva perdasilva added documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. labels Aug 14, 2024
@perdasilva perdasilva changed the title Overall architecture diagram Docs: Reference: Overall architecture diagram Aug 14, 2024
@perdasilva perdasilva changed the title Docs: Reference: Overall architecture diagram Docs: Overall architecture diagram Aug 14, 2024
@everettraven everettraven added this to the v1.0.0 milestone Aug 20, 2024
@everettraven everettraven added the v1.0 Issues related to the initial stable release of OLMv1 label Aug 27, 2024
@LalatenduMohanty LalatenduMohanty self-assigned this Sep 3, 2024
@LalatenduMohanty
Copy link
Member

@joelanford suggested that if the diagram can have links to respective code paths/components, it would be very useful.

@LalatenduMohanty LalatenduMohanty changed the title Docs: Overall architecture diagram Docs: Overall architecture documentation Sep 3, 2024
@michaelryanpeter
Copy link
Contributor

Mermaid implementation in the Material MK docs:
https://squidfunk.github.io/mkdocs-material/reference/diagrams/?h=mermaid

https://mermaid.js.org/

@LalatenduMohanty
Copy link
Member

Working on a google doc https://docs.google.com/document/d/1pYmV5vHNPLVlMTc8qqqsQcdnbKH98j6aICUL5SwYsP0/edit, this is work in progress. Once I have enough content I will create a PR

@LalatenduMohanty LalatenduMohanty mentioned this issue Sep 23, 2024
Merged
4 tasks
LalatenduMohanty added a commit to LalatenduMohanty/operator-controller that referenced this issue Sep 23, 2024
@LalatenduMohanty
Adding OLM V1 architecture document
edcbd6a 
The documentation contains description of the components and a diagram.
Removed the components.md file as the architecture doc contains the same
information

Fixes : [operator-framework#1124](operator-framework#1124)

Signed-off-by: Lalatendu Mohanty <[email protected]>
LalatenduMohanty added a commit to LalatenduMohanty/operator-controller that referenced this issue Sep 23, 2024
@LalatenduMohanty
Adding OLM V1 architecture document
b4e3796 
The documentation contains description of the components and a diagram.
Removed the components.md file as the architecture doc contains the same
information

Fixes : [operator-framework#1124](operator-framework#1124)

Signed-off-by: Lalatendu Mohanty <[email protected]>
LalatenduMohanty added a commit to LalatenduMohanty/operator-controller that referenced this issue Sep 23, 2024
@LalatenduMohanty
Adding OLM V1 architecture document
deeeb1e 
The documentation contains description of the components and a diagram.
Removed the components.md file as the architecture doc contains the same
information

Fixes : [operator-framework#1124](operator-framework#1124)

Signed-off-by: Lalatendu Mohanty <[email protected]>
LalatenduMohanty added a commit to LalatenduMohanty/operator-controller that referenced this issue Sep 23, 2024
@LalatenduMohanty
Adding OLM V1 architecture document
8a0beb5 
The documentation contains description of the components and a diagram.
Removed the components.md file as the architecture doc contains the same
information

Fixes : [operator-framework#1124](operator-framework#1124)

Signed-off-by: Lalatendu Mohanty <[email protected]>
github-merge-queue bot pushed a commit that referenced this issue Sep 25, 2024
@LalatenduMohanty @perdasilva
📖 Adding OLM V1 architecture document (#1301)
d1a4dbf 
* Adding OLM V1 architecture document

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](#1124)

Signed-off-by: Lalatendu Mohanty <[email protected]>

* Update docs/drafts/architecture.md

Co-authored-by: Per Goncalves da Silva <[email protected]>

* Update docs/drafts/architecture.md

Co-authored-by: Per Goncalves da Silva <[email protected]>

* Update docs/drafts/architecture.md

Co-authored-by: Per Goncalves da Silva <[email protected]>

* Update docs/drafts/architecture.md

Co-authored-by: Per Goncalves da Silva <[email protected]>

* Addressing the review comments for the arch doc

Signed-off-by: Lalatendu Mohanty <[email protected]>

---------

Signed-off-by: Lalatendu Mohanty <[email protected]>
Co-authored-by: Per Goncalves da Silva <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@LalatenduMohanty LalatenduMohanty

Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Projects
OLM v1
Archived in project
Milestone
v1.0.0
Development

Successfully merging a pull request may close this issue.

📖 Adding OLM V1 architecture document LalatenduMohanty/operator-controller
4 participants
@perdasilva @LalatenduMohanty @everettraven @michaelryanpeter