fedora-iot / iot-docs Goto Github PK
View Code? Open in Web Editor NEWRepository for IoT docs for docs.fp.o
Home Page: https://docs.fedoraproject.org/en-US/iot/
Repository for IoT docs for docs.fp.o
Home Page: https://docs.fedoraproject.org/en-US/iot/
This is a collection of new topic content ideas for iot-docs during the F29 release.
Modify kernel arguments with rpm-ostree kargs
Expand logging in the Administration Tasks for auditd and remote logging options.
Per taiga board, there is interest in:
Working with camera devices and LTE
Security with usbguard and clevis
Some of those may require layered packages or waiting for F30.
Get ready for F30 options like greenboot.
More examples with packages and containers that are available from Fedora repositories that might be used with the IoT image. For example Mozilla Gateway as soon as it is approved.
Documenting the way we run the IoT Weekly meeting on Matrix would be a good idea. Make sure to cover meeting invites, picking topics, and addressing Matrix-specific commands (i.e. !action, !help, !chair, etc).
if you enter https://docs.fedoraproject.org/en-US/iot/reference-platforms/ with dark mode on, you will see a lot of unreadable almost-black text on black background.
Screenshot:
Ostree supports automatically staging updates. Add a section on how to enable that with links to upstream docs for further information.
Make it easier to find information for contributors. Add information that would answer frequent questions from developers, contributors, and potential contributors.
Start with repeating the how to get in touch links. Currently the links to the pagure repos, mailing list, and IRC channel are on the welcome page and repeated in other locations as well. Start with those.
Consider if the questions from contributors should be answered as advanced topics in the user guide section. Some examples for the user guide might be:
How do I add a device driver to the initramfs?
How do I compose my own tree?
For contributor specific sections maybe some of these questions:
How do I test release candidates?
How do I package my application for Fedora IoT?
How do I submit a patch for an image (or doc)
Contribute by Promoting Fedora IoT
Some of the docs still refer to Pagure. Check to make sure they're correct, because some/all have moved to GitHub.
In the contribution guide, 11AM EST is the time of the meeting. In reality, we are currently holding it an hour earlier
I followed the guide at: https://docs.fedoraproject.org/en-US/iot/booting-the-simplified-provisioner/
When using virt-install, we see an example of the image URL
Enter the HTTPBoot URL (see above) (e.g.: http://192.168.122.1:9080/EFI/BOOT/BOOTX86.efi) and press "[Enter]"
the extension should probably be in caps
Depends on #1
Review and clean up documentation:
Hi.
On the docs of the Fedora IoT, the chapter Example: Interaction with GPIO interface referer to the command sudo gpiodetect
, but this command not exits on my installation of the Fedora IoT 6.8.9-300.fc40.aarch64
.
Why doesn't the command exist?
Maybe it was deprecated and replaced with something else?
Thanks.
Antonio.
Let's document how to deploy pi-hole on Fedora IoT system.
I think it would be great to show deploying pi-hole via container, maybe via a podman systemd unit
Add how to disable user ssh password authentication to [admin-tasks/User Management].
Add some documentation that describes the process of building custom iot disk images and perhaps installers (simplified provisioning) with Image Builder (osbuild).
Upstream documentation:
https://osbuild.org/docs/user-guide/introduction
We should add a section for recovering the root password. Likely with an encrypted root so the whole process is there
Add instructions for determining system ip address for ssh to [Setting up a Device with Zezere].
In the Fedora IoT meeting today, we discussed cleaning up the current docs for accuracy.
Notably, the armhfp
platform was EOL as of F36
@paulwhalen @coremodule @nullr0ute please add any additional details that should be captured here
Firstly thankyou for the wonderful software and documentation you have, I have been using Fedora for many years. Also apologies if any of the below is not completely accurate, it's just my understanding from reading various documentation.
TLDR: there are no physical device install instructions for Fedora IoT x86_64 here.
Would it be possible to add instructions for using the Fedora Media Writer to install Fedora IoT on x86_64?
Longer version:
I initially installed Fedora IoT on my raspberry pi (ARM) and found the documentation very helpful. More recently I wished to install Fedora IoT on an x86_64 computer rather than ARM, however I noticed there is no information in the physical device setup relating to x86_64. The only information I could find about x86_64 is in the 'Setting up a Virtual Machine' which is not applicable to this situation with a physical computer.
However, after a fair bit of playing around I discovered that the Fedora Media Writer supports Fedora IoT, which essentially lets Fedora IoT be booted as a live disk. From the Fedora IoT documentation I did not realise the following:
- That the Fedora Media Writer can be used to install Fedora IoT on a device such as a USB.
- The Fedora IoT iso (at least the x86_64 version I used) is a live image that can also install the operating system on another disk
Add some basic details of greenboot and link to upstream and/or other appropriate documentation.
It would be good to have a light weight user guide for podman 4 networking. Maybe cover a NAT style network and a bridged network. Include also good links to upstream docs on the podman network piece.
Let's document how to deploy Home Assistant on Fedora IoT
The toolbox tool is a great means of creating discrete development environments on an immutable platform like Fedora IoT. Document the means of installing and setting up toolbox so it can be used on Fedora IoT for those sorts of usecases.
Silverblue has good docs that can be used as a basis for these docs:
https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/
It still uses apps.fp.o, which doesn't work
Add a quick user guide for using clevis to do automatic disk unlocking
There's a few extra steps required in Fedora to use UEFI and a SW TPM2 with gnome boxes. We should have this documented to make things easy. The details are covered in this blog: https://www.ctrl.blog/entry/how-to-win11-in-gnome-boxes.html
This does nothing to actually tell people how to do this. It offers a dodge of "some repos have a helper" which is not applicable to most cases.
We mention Libera but don't mention chat.fedoraproject.org.
The scroll bar is ridiculously thin, about a third or forth of the default width (capable of containing the width of the mouse cursor) I get on most sites.
This is problematic when I try to interact with it to scroll via dragging the scrollbar (and no up/down arrow buttons are available either..). If I am patient, after some frustration I think I've successfully been able to scroll this way, but often the click is not captured on the scrollbar or the pointer cursor changes to a window resize cursor, likewise preventing me from scrolling (probably works if I fullscreen/maximize the window, haven't checked).
Not sure if this was intentional as some sort of aesthetic, but it ruins a11y of the scrollbar beyond a subtle indication of scroll position and page length. The issue is less problematic on touchscreen devices or laptops with touchpads.
We should replace the example for qemu-kvm with a virt-install command to make things more straight forward.
Reference platforms page is broken in dark mode due to dark-on-dark text:
https://docs.fedoraproject.org/en-US/iot/reference-platforms/
We currently don't have documentation that shows how we pick which IoT compose will become a milestone (beta, final). We do have a process that we follow, but it hasn't been written down.
Link to the IoT Weekly Meeting where this was brought up:
(https://meetbot.fedoraproject.org/fedora-meeting/2024-01-10/fedora_iot_working_group_meeting.2024-01-10-16.00.log.html)
Currently the simplified-provisioning
section of our documentation is missing a description of the simplified provisioning, add one.
Docs:
https://docs.fedoraproject.org/en-US/iot/booting-the-simplified-provisioner/
F40 change:
https://fedoraproject.org/wiki/Changes/IoTSimplifiedProvisioning
Since we're not using Taiga anymore, we should make sure the docs don't point to it.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.