Fedora Internet of Things is a variant of Fedora focused on IoT ecosystems. This month I had the opportunity to focus on the Fedora IoT Documentation with the working group as a part advancing their objectives.
What was done
I began by expanding the “Getting Started” section to help people do as the title indicates: get started. This section is focused on getting the images downloaded and a device up and running with an initial user. The steps are detailed enough to help those that are also new to Fedora distributions.
Next I reorganized some of the remaining initial content into a “User Guide” section. This section covers topics thought of as the “next steps” in using the Fedora IoT images. I detailed the steps for managing updates with rpm-ostree and switching between development and stable builds. I also added examples for layered packages, adding repositories, and even running containers. Finally I provided some pointers for other administration tasks with links to existing Fedora Documentation.
What is next
Design ideas: My focus was on technical content. The basic layout is dictated by the Fedora Docs project but a bit of design work on the welcome page and the addition of any IoT specific logos would be nice. Also, there are a few screenshots that could use a pointer or box to highlight the area described in the text.
Verify links for downloads and upgrades: The working group now has regular updated images available in a CDN and the next downloadable image is in progress along with the final version of the landing page for downloads. Once the update and release schedule process is smoothed out, the documentation needs to be verified.
Get ready for F30: When Fedora 30 is ready, the site will need some Release Notes and the User Guide will need some updates to cover new features. You can submit suggestions as iot-docs issues in pagure.
A lot of progress was made this month and I learned more about asciidoc, ostree, and my Pi device. Also that my fingers are too big for microSD cards!
Check out the content at https://docs.fedoraproject.org/en-US/iot/
Feedback is welcome — just let us know with an iot-docs issue or through any of the methods mentioned on the welcome page!