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 project overview page #434

Merged
merged 2 commits into from
May 27, 2024
Merged

Add project overview page #434

merged 2 commits into from
May 27, 2024

Conversation

lentzi90
Copy link
Member

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.

@lentzi90
Add project overview page
10ada95 
This page gives a high level overview of the project, including some
graphs and requirements.

Signed-off-by: Lennart Jern <lennart.jern@est.tech>
@metal3-io-bot metal3-io-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 24, 2024
@metal3-io-bot
Copy link
Contributor

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 metal3-io-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 24, 2024
@lentzi90 lentzi90 marked this pull request as ready for review May 24, 2024 06:48
@metal3-io-bot metal3-io-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 24, 2024
kashifest
kashifest reviewed May 24, 2024
View reviewed changes
Copy link
Member

@kashifest kashifest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@metal3-io-bot metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 24, 2024
tuminoid
tuminoid reviewed May 24, 2024
View reviewed changes
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely addition!

/lgtm
/hold
Giving some time for others to check it.

@metal3-io-bot metal3-io-bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. labels May 24, 2024
dtantsur
dtantsur previously approved these changes May 27, 2024
View reviewed changes
Copy link
Member

@dtantsur dtantsur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great addition! A couple of ideas for a potential follow-up inline.

@lentzi90
Add linting make targets
4243db4 
This adds make targets for markdownlint, shellcheck and spellcheck, as
well as "lint" for running them all.

Signed-off-by: Lennart Jern <lennart.jern@est.tech>
@metal3-io-bot metal3-io-bot removed the lgtm Indicates that a PR is ready to be merged. label May 27, 2024
@metal3-io-bot
Copy link
Contributor

[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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

1 similar comment
@metal3-io-bot
Copy link
Contributor

[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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@lentzi90
Copy link
Member Author

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 🙂

@lentzi90
Copy link
Member Author

/hold cancel

@metal3-io-bot metal3-io-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 27, 2024
tuminoid
tuminoid reviewed May 27, 2024
View reviewed changes
Copy link
Member

@tuminoid tuminoid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label May 27, 2024
@metal3-io-bot metal3-io-bot merged commit 011ebe7 into metal3-io:main May 27, 2024
8 of 9 checks passed
@metal3-io-bot metal3-io-bot deleted the lentzi90/project-overview branch May 27, 2024 17:12
dtantsur
dtantsur reviewed May 28, 2024
View reviewed changes
docs/user-guide/src/project-overview.md

- Server(s) with baseboard management capabilities (i.e. Redfish, iDRAC, IPMI,
etc.). For development you can use virtual machines with Sushy-tools. More
information [here](./bmo/supported_hardware.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the future: we should avoid links called "here". I've learned that these are not friendly to accessibility tools (e.g. if a blind user wants the tool to read aloud all links).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kashifest kashifest kashifest left review comments

@tuminoid tuminoid tuminoid left review comments

@dtantsur dtantsur dtantsur left review comments

@zhouhao3 zhouhao3 Awaiting requested review from zhouhao3

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lentzi90 @metal3-io-bot @dtantsur @tuminoid @kashifest