Improvements for the Fedora IoT documentation

[knecasov]

Typos

• In the "Creating an Ignition configuration file" section [1], there is probably a typo in the command podman run -i --rm quay.io/coreos/butane --pretty --strict < fiot.bn | tee fiot.ign. I think that there should be a fiot.bu.
• In the "Verifying the installation" section [2], there is an extra $ in the command ssh core@$192.168.122.10.

Recommendations

• I would appreciate specific steps here [2] for the step "You have created an Ignition configuration file and is accessible via HTTP/HTTPS.".
  I did not know what to imagine under the part "accessible via HTTP/HTTPS".
• I would also emphasize here [2] for the step "As the device boots, edit the kernel args and add the url to your ignition config, for example: ignition.config.url=http://192.168.122.1/fiot.ign" that it has to be done during the first boot.

[1] https://docs.fedoraproject.org/en-US/iot/creating-an-ignition-configuration-file/
[2] https://docs.fedoraproject.org/en-US/iot/ignition-device-setup/

[nullr0ute]

Typically please file an issue ticket per issue as things are generally addressed independently.

Any chance you can do a PR for the typos?

I did not know what to imagine under the part "accessible via HTTP/HTTPS".

You need to have a web service running serving the ignition file so the IoT install can remotely access the file across the network.

[knecasov]

Hi @nullr0ute,

Thank you very much for the information. Should I split the issue into two separate issues, please? I can leave this one for the typos and create another for the recommendations.

I can definitely create a PR to fix the typos myself.

Thank you very much for the clarification. I hope I understand correctly that recommendations will be addressed by someone else if they are accepted.

[nullr0ute]

so let's leave this ticket as it is for the moment, submit PR(s) for the docs separately and just reference this ticket, or reference them here. We can work through the best requirements for the recommendations here :)

[knecasov]

I created a PR for typos. Thank you very much, I am open for a discussion about the Recommendations section.