search

theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem
https://docs.theforeman.org
Creative Commons Attribution Share Alike 4.0 International
22 stars 95 forks source link

Add diagram of installer-based provisioning with subnet bootdisk #3309

Open Lennonka opened 2 months ago

Lennonka commented 2 months ago

What changes are you introducing?

Adding a sequence diagram of installer-based provisioning with subnet bootdisk. Using PlantUML to build the diagram.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Preparation for improvements of Provisioning hosts. The diagram will be used later to explain the workflow of the provisioning method.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

Please cherry-pick my commits into: N/A

github-actions[bot] commented 2 months ago

The PR preview for 20129f974270ba367959a1ac49d122bb65a31802 is available at theforeman-foreman-documentation-preview-pr-3309.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

apinnick commented 1 month ago

Could you please embed the diagram in an adoc file so that we can see how the diagram renders?

Lennonka commented 1 month ago

@apinnick There's a rendered PNG file of the diagram included with the PR for a preview.

Currently, there's no good place to include them.

Lennonka commented 1 month ago

@apinnick FYI, we're currently working on #3304, so I will start incorporating your suggestions there first. Some of the files (.iuml) are going to be reused in the other PlantUML diagrams once merged and rebased. Also, I think you mentioned that downstream expects sentence-case for the text in steps, so I'm going to apply that as well.

Thank you for your review, much appreciated!

apinnick commented 1 month ago

@apinnick There's a rendered PNG file of the diagram included with the PR for a preview.

Currently, there's no good place to include them.

@Lennonka Seeing the rendered PNG file is not the same as seeing it in an .adoc file. If there is no good place to include this diagram, I recommend that you create a temporary .adoc file and embed it in an assembly (with lots of warnings that this is for review purposes only) so that we can see how a diagram of this size renders on the page. The text might be too small to read.

Lennonka commented 3 weeks ago

@stejskalleos GH won't let me assign you as a reviewer to this PR, so I'm tagging you :)

PS. I didn't manage to incorporate comments from previous PRs yet.

Lennonka commented 3 weeks ago

Initial feedback incorporated. cc @stejskalleos