_faqs: Add frequently asked quetions from the Chemnitzer Linux Tage #125

maribu · 2024-03-21T12:31:43Z

A number of questions frequently asked at the Chemnitzer Linux Tage about RIOT is not covered by the FAQs. So, let's add them :)

@kfessel, @mguetschow, @benpicco may also recall some common questions that are not in the list yet.

The question regarding citation seemed to have intentionally been at the bottom, let's make sure it keeps that way.

github-actions · 2024-03-21T12:34:10Z

🚀 PR preview deployed to https://RIOT-OS-riot-os-org-preview-125.surge.sh

_faqs/faq-12.md

maribu · 2024-03-21T12:57:37Z

Hint for the reviewers: The summary diff provided here is a bit misleading, a look at 42d51ce details accurately what happened to the citation FAQ.

_faqs/faq-12.md

jkarinkl

Some notes on the Arduino and Zephyr comparison.

jkarinkl · 2024-03-21T16:43:44Z

_faqs/faq-12.md

- * Emmanuel Baccelli, Cenk G&uuml;ndo&#287;an, Oliver Hahm, Peter Kietzmann, Martine Lenders, Hauke Petersen, Kaspar Schleiser, Thomas C. Schmidt, Matthias W&auml;hlisch, <a href="{{ "assets/pdfs/riot-ieeeiotjournal-2018.pdf" | relative_url }}">RIOT: An Open Source Operating System for Low-End Embedded Devices in the IoT</a>, IEEE Internet of Things Journal, Vol. 5, No. 6, pp. 4428-4440, December 2018.
+Compared to **Arduino**, RIOT provides advanced features such as native multi-threading and a mature network stack, while still providing a gentle learning curve.
+This allows new users to quickly get productive with RIOT without limiting developers to specific design patterns and software architectures.
+As a nice treat for users migrating from Arduino, our [Arduino compatibility layer](https://doc.riot-os.org/group__sys__arduino.html) allows re-using sketches and libraries from the Arduino world.



What I have heard from David (emeutier at the forum) during an interview about learning solutions for RIOT beginners (see forum thread) is that RIOT is long term nicer to work with than Arduino.

Once you figure out how RIOT works, you can reuse the basic code of RIOT and several bricks. With Arduino, you always have a different interface. Arduino libraries are build everything from scratch every time, code cannot be reused easily. RIOT is centralized, that is nice and works good. Arduino is shattered.

Might be useful to add something about this reuse of code here as well?

_faqs/faq-12.md

mguetschow

Thanks a lot for the write-up @maribu ! Some comments and typo fixes below.

_faqs/faq-12.md

maribu · 2024-03-25T14:23:49Z

OK, this got quite a bit larger. I hope I picked up all the comments.

mguetschow

Wow, indeed a big one, thank you! Some typo fixess and suggestions below.

Don't we want to link to the other projects?

_faqs/faq-12.md

jkarinkl

Nice text! It is really clear what the differences are and also why RIOT is great :).
Thanks for writing this and improving the text.

I have some feedback on governance vs government word use and some grammar.

_faqs/faq-12.md

jkarinkl · 2024-03-25T14:58:05Z

_faqs/faq-12.md

+As a nice treat for users that started with Arduino but ran in limitations, our [Arduino compatibility layer][riot-arduino] allows re-using sketches and libraries from the Arduino world.
+
+Arduino has a vast ecosystem of libraries developed independently by 3rd parties.
+RIOT set of modules and packages is not that vast, but RIOT's modules are seamlessly integrated, have a consistent APIs and integrate well with each others.


Grammar line 53:

'RIOT's set.... ' instead of 'RIOT set...'

'APIs' or 'API'?

'other' instead of 'others'

i would argue against the genitive in the phrase about the set. RIOT does not own sets. RIOT is an operating system. if you refer to the RIOT community, it would be weird, too.

How about "The number of modules and packages shipped with RIOT is smaller, but they are seamlessly integrated, provide a consistent API and combine well with each other."?

_faqs/faq-12.md

maribu · 2024-03-25T15:45:17Z

Don't we want to link to the other projects?

Good idea, see cc0b4d7

_faqs/faq-12.md

mguetschow

LGTM as is! Anything left to do from your side @maribu or can we merge?

maribu · 2024-04-22T12:07:54Z

I think this is ready now :)

miri64 · 2024-04-22T13:42:28Z

_faqs/faq-12.md

+
+RIOT is distributed under a copyleft license and strongly prefers free and open source components over proprietary code and binary blobs.
+Still, RIOT does contain proprietary drivers (some even using binary blobs) where no free alternative is available, e.g. for the ESP WiFi chipset.
+<!-- FIXME: Make FAQ entries linkable and link to "Why LGPL?" -->


Was this intended to be addressed here? While I am not sure if there is a "programmable" reference system, the FAQ entries are linkable since they have an anchor. The anchor for "Why LGPL?" is #faq2. If it is not intended to be addressed here: Remove?

I tested https://www.riot-os.org/#faq2 and it does not work for me. There also is no anchor in the HTML.

I think it would make sense to add the link, but making the FAQ entries linkable is IMO out of scope. (It would also make sense to have more stable IDs, as reordering the entries would break a number based system.)

It works for me iff the FAQ entry is already expanded.

I tested https://www.riot-os.org/#faq2 and it does not work for me. There also is no anchor in the HTML.

Huh? There is for me (see screenshot below) and it is also present in the Jekyll template

riot-os.org/index.html

Line 471 in be5b390

<div id="faq{{ forloop.index }}" class="collapse" data-bs-parent=".faq-list">

Ah, it only works, if the FAQ is expanded... Ok, then let's postpone this.

Github showed me https://github.com/RIOT-OS/riot-os.org/pull/125/files#r1574802395 only now after hitting Refresh 😭

Same. If I use <a id="faq-license">...</a> it also works when the FAQ entry is not expanded.

Ah, it only works, if the FAQ is expanded... Ok, then let's postpone this.

See #127

_faqs/faq-12.md

miri64 · 2024-04-22T14:02:36Z

Co-authored-by: Martine Lenders <mail@martine-lenders.eu>

Can you use my TU Dresden address here, please?

maribu · 2024-04-22T14:04:34Z

Co-authored-by: Martine Lenders <mail@martine-lenders.eu>

Can you use my TU Dresden address here, please?

Sure! You may want to change your GitHub settings, though, as this was copied verbatim from the "accept suggestion" commit.

Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de> Co-authored-by: Karin Lammers <helloworld@karinlammers.eu> Co-authored-by: Martine Lenders <martine.lenders@tu-dresden.de>

miri64

Sure! You may want to change your GitHub settings, though, as this was copied verbatim from the "accept suggestion" commit.

Done and ACK!

mguetschow · 2024-04-22T14:16:21Z

Thanks everyone! 🎉

maribu added 2 commits March 21, 2024 09:56

_faqs: move faq-12.md to faq-99.md

42d51ce

The question regarding citation seemed to have intentionally been at the bottom, let's make sure it keeps that way.

_faqs: Why choose RIOT over bare metal

7aac518

chrysn reviewed Mar 21, 2024

View reviewed changes

_faqs/faq-12.md Outdated Show resolved Hide resolved

waehlisch reviewed Mar 21, 2024

View reviewed changes

_faqs/faq-12.md Outdated Show resolved Hide resolved

jkarinkl reviewed Mar 21, 2024

View reviewed changes

mguetschow requested changes Mar 22, 2024

View reviewed changes

mguetschow requested changes Mar 25, 2024

View reviewed changes

jkarinkl reviewed Mar 25, 2024

View reviewed changes

_faqs/faq-12.md Outdated Show resolved Hide resolved

maribu force-pushed the faq/chemnitzer-linux-tage branch from 362631f to b663067 Compare April 9, 2024 10:58

mguetschow approved these changes Apr 22, 2024

View reviewed changes

miri64 reviewed Apr 22, 2024

View reviewed changes

_faqs/faq-12.md Outdated Show resolved Hide resolved

maribu force-pushed the faq/chemnitzer-linux-tage branch from f1b17fb to ee24c26 Compare April 22, 2024 13:56

_faqs: Compare RIOT to other players

ef6c8e3

Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de> Co-authored-by: Karin Lammers <helloworld@karinlammers.eu> Co-authored-by: Martine Lenders <martine.lenders@tu-dresden.de>

maribu force-pushed the faq/chemnitzer-linux-tage branch from ee24c26 to ef6c8e3 Compare April 22, 2024 14:05

miri64 approved these changes Apr 22, 2024

View reviewed changes

miri64 merged commit 3c659d5 into RIOT-OS:master Apr 22, 2024
1 check passed

maribu deleted the faq/chemnitzer-linux-tage branch April 22, 2024 14:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

_faqs: Add frequently asked quetions from the Chemnitzer Linux Tage #125

_faqs: Add frequently asked quetions from the Chemnitzer Linux Tage #125

maribu commented Mar 21, 2024

github-actions bot commented Mar 21, 2024 •

edited

Loading

maribu commented Mar 21, 2024

jkarinkl left a comment

jkarinkl Mar 21, 2024

mguetschow left a comment

maribu commented Mar 25, 2024

mguetschow left a comment

jkarinkl left a comment

jkarinkl Mar 25, 2024

waehlisch Mar 25, 2024

mguetschow Mar 25, 2024

maribu commented Mar 25, 2024

mguetschow left a comment

maribu commented Apr 22, 2024

miri64 Apr 22, 2024

maribu Apr 22, 2024

mguetschow Apr 22, 2024

miri64 Apr 22, 2024

miri64 Apr 22, 2024

miri64 Apr 22, 2024

maribu Apr 22, 2024

miri64 Apr 22, 2024

miri64 commented Apr 22, 2024

maribu commented Apr 22, 2024

miri64 left a comment

mguetschow commented Apr 22, 2024

_faqs: Add frequently asked quetions from the Chemnitzer Linux Tage #125

_faqs: Add frequently asked quetions from the Chemnitzer Linux Tage #125

Conversation

maribu commented Mar 21, 2024

github-actions bot commented Mar 21, 2024 • edited Loading

maribu commented Mar 21, 2024

jkarinkl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mguetschow left a comment

Choose a reason for hiding this comment

maribu commented Mar 25, 2024

mguetschow left a comment

Choose a reason for hiding this comment

jkarinkl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maribu commented Mar 25, 2024

mguetschow left a comment

Choose a reason for hiding this comment

maribu commented Apr 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miri64 commented Apr 22, 2024

maribu commented Apr 22, 2024

miri64 left a comment

Choose a reason for hiding this comment

mguetschow commented Apr 22, 2024

github-actions bot commented Mar 21, 2024 •

edited

Loading