Skip to content

Add Blueprint Framework and FAQ document#87

Open
horms wants to merge 5 commits intoopiproject:mainfrom
horms:blueprint-framework
Open

Add Blueprint Framework and FAQ document#87
horms wants to merge 5 commits intoopiproject:mainfrom
horms:blueprint-framework

Conversation

@horms
Copy link

@horms horms commented Feb 23, 2026

Provide a document that outlines a the framework for blueprints and provides a FAQ.

This work was contributed by @josh-wtit.
I have made only formatting changes.

Please review and provide feedback.

@horms horms requested a review from a team as a code owner February 23, 2026 14:44
@horms
Copy link
Author

horms commented Feb 23, 2026

It seems there are some problems flagged by linters, I'll address that ASAP.

@josh-wtit
Copy link

Provide a document that outlines a the framework for blueprints and provides a FAQ.

This work was contributed by @josh-wtit. I have made only formatting changes.

Please review and provide feedback.

Commenting for tracking that the original .docx format of this document was contributed to the OPI Project by myself/WorldTech IT.

@horms horms force-pushed the blueprint-framework branch 2 times, most recently from 36926e5 to 2f74b60 Compare February 23, 2026 15:31
Ignore MD059 - Link text should be descriptive

This is flagged by the use of '[here]' multiple times in
Docs/opi-scope.md. That can be addressed as desired.
But in the meantime it seems just as well to disable this check.

Doing so makes the tree clean with regards to lint checks.

Link: https://github.com/DavidAnson/markdownlint/blob/main/doc/md059.md
Signed-off-by: Simon Horman <simon.horman@redhat.com>
@horms horms force-pushed the blueprint-framework branch from 2f74b60 to 61f19c0 Compare February 23, 2026 15:34
Simon Horman added 4 commits February 23, 2026 15:38
This document describes OPI blueprints.
Original text supplied by Josh Brooks <josh@worldtechit.com>.

Signed-off-by: Simon Horman <simon.horman@redhat.com>
Update formating to use first and second level headers
in place of table-based formating.

This seems more appropriate for a Markdown document.

Signed-off-by: Simon Horman <simon.horman@redhat.com>
Attribution was split between the top and the bottom of the document.
It seems clearer to gather it together at the top.

Signed-off-by: Simon Horman <simon.horman@redhat.com>
This markdown document was created using an automated conversion
from another format. Which did not line-wrap the text.
Do so as that seems appropriate for a text file.

The text is otherwise unmodified by this rather verbose change.

Signed-off-by: Simon Horman <simon.horman@redhat.com>
@horms horms force-pushed the blueprint-framework branch from 61f19c0 to cee570e Compare February 23, 2026 15:38
@horms
Copy link
Author

horms commented Feb 23, 2026

I corrected all the linting problems (all workflows are green).

This included adding a new patch to ignore markdown check md059, which was failing prior to this pull request.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants