search

metal3-io / metal3-docs

Architecture documentation that describes the components being built under Metal³.
http://metal3.io
Apache License 2.0
263 stars 111 forks source link

Add project overview page #434

Closed lentzi90 closed 1 month ago

lentzi90 commented 1 month ago

This page gives a high level overview of the project, including some graphs and requirements.

It is overlapping a bit with the introduction page, but I hope it will feel more hands-on and explain a bit better how it works, rather than what the project is about.

I also added make targets for linting.

metal3-io-bot commented 1 month ago

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

metal3-io-bot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kashifest

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/metal3-io/metal3-docs/blob/main/OWNERS)~~ [kashifest] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
metal3-io-bot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kashifest

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/metal3-io/metal3-docs/blob/main/OWNERS)~~ [kashifest] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
lentzi90 commented 1 month ago

Thanks for the suggestions! I have added the links. Also started on a diagram for BareMetalHosts, FirmwareSchema, etc, but it grew out of proportions. I'll leave it for now and hopefully come back to it at a later point. Let's merge this though :slightly_smiling_face:

lentzi90 commented 1 month ago

/hold cancel