Conversation
5171d9a to
860cfe9
Compare
Signed-off-by: |°_°| <grivel.theo@protonmail.com>
Signed-off-by: |°_°| <grivel.theo@protonmail.com>
|
looks like a lot of overlap between this and the tutorial. https://github.com/OpenCHAMI/tutorial-2025 Can we find a way to maintain fewer of these? |
There was a problem hiding this comment.
Out of curiosity, is there a reason for using asciidoc instead of plain markdown? This introduces another dependency for rendering documents and markdown is already generally well supported. On the other hand, some of our repos are using scdoc, but that's mainly just for man pages.
There was a problem hiding this comment.
I've been using AsciiDoc for a long time, and now I prefer AsciiDoc to Markdown.
I find AsciiDoc to be as simple as Markdown, but with extra features.
eg. include file content in document,
you can separate data and documentation.
and other detail I found great:
for an ordered list:
Markdown
1. one
\```shell <- indentation
$ one
\```
1. secondAsciiDoc
. one
+
[source,shell]
---- <- no indentation required
$ one
----
. secondThere was a problem hiding this comment.
I think following the instructions provided in this README is fine, but the structure using bash scripts for each step makes it difficult to understand what is going on without having to view the scripts themselves. For a quick start, I would hate to have to parse through a bunch of bash code to understand the main logic.
I think there should be a balance between the bash helper scripts and direct commands similar the README in the podman quadlets. Personally, I would prefer to have mostly direct commands in the README with a little more explanation like in the tutorial as to what is actually happening at each step. It doesn't have to be as fleshed out, but I'd consider what the experience would be like for someone who has never interacted with OpenCHAMI before if they choose to follow this guide first.
There was a problem hiding this comment.
Thanks for having reviewed my pull request, and providing many constructive feedback.
It helps me as a guideline.
Currently I am working on a Terraform provider, I'll probably replace bash script by terraform.
It may reduce the number of bash script and increase the number of commands.
Signed-off-by: |°_°| <grivel.theo@protonmail.com>
Create bare-metal guide
Show how could OpenCHAMI be deployed on a baremetal environment.
Create a guide inspired by Metal3's quickstart.
This explain how to use
Reviewing
Go to the baremetal folder.