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

Add concept document describing API types #62

Closed
afritzler opened this issue Jul 2, 2024 · 0 comments · Fixed by #152
Closed

Add concept document describing API types #62

afritzler opened this issue Jul 2, 2024 · 0 comments · Fixed by #152
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@afritzler
Copy link
Member

Summary

Add a concept document under docs/concepts to cover all core types of the metal-operator. Also illustrate how those types are related. Outline also which reconciler is responsible for which API type.

For the Server resource describe the various states a Server can be in, including a state machine representation.
@afritzler afritzler added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 2, 2024
@afritzler afritzler moved this from Backlog to Ready in Metal Automation Jul 2, 2024
@afritzler afritzler mentioned this issue Oct 29, 2024
Merged
@github-project-automation github-project-automation bot moved this from Ready to Done in Metal Automation Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Metal Automation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add initial project documentation ironcore-dev/metal-operator
1 participant
@afritzler