README: Rephrase forum into more generic help by bergzand · Pull Request #20413 · RIOT-OS/RIOT

bergzand · 2024-02-22T08:51:04Z

Contribution description

This PR replaces the section called 'Forum' with a more generic section on 'asking for help'. I couldn't find something similar at first glance in our documentation so it is likely helpful for newcomers to explicitly add this.

Testing procedure

Read the update to the readme and check whether all the links added work.

Issues/PRs references

None

README.md

waehlisch · 2024-02-22T09:12:02Z

README.md

+You can ask for help on the Forum or on Matrix. Please send bug reports and
+feature requests to our [github issue tracker](https://github.com/RIOT-OS/RIOT/issues)
+
+- [forum](https://forum.riot-os.org) is the default place to start asking for


Forum ... is the default place to ask for help. The Forum provides an archive of prior questions and answers.

Forum ... is the default place to ask for help. The Forum provides an archive of prior questions and answers.

I don't follow your comment here, could you clarify a bit? Is this a suggestion to rephrase the sentence into the content of your comment?

yes, this comment was about rephrasing.

Forum is the default place to ask for help. Our Forum provides an archive of prior questions and answers.

waehlisch · 2024-02-22T09:12:40Z

README.md

+
+- [forum](https://forum.riot-os.org) is the default place to start asking for
+help. The search can be used to find older questions and answers.
+- We use [#riot-os:matrix.org](https://matrix.to/#/#riot-os:matrix.org) on the


For rather synchronous chats, we use the ...

IMO the term "synchronous" here is odd. For one, it is technically not correct. Second, the term is too technical here IMO with regard to the diverse target audience that may just wants to start tinkering and has no strong computer science background.

thanks for this constructive comment.

easy to solve: For chats, we use [...]

README.md

waehlisch · 2024-02-22T09:15:22Z

README.md

+### How to Ask
+
+Please include as much detail as you can that is relevant to your question, not
+only "this isn't working".


... These details include

waehlisch · 2024-02-22T09:15:37Z

README.md

+Please include as much detail as you can that is relevant to your question, not
+only "this isn't working".
+
+1. What you want to achieve


. //for all three items.

jkarinkl · 2024-03-06T15:03:26Z

I wonder if the part you now call should be called 'Communications', with a sub part into 'asking for help'. Since you sum up the communication channels used (forum, matrix chat, GitHub). See this README-template for an overview of communications.

The used social media can also be summed up here (mastadon, youtube, ..?)

The sub part of communications will then be 'asking for help', stating that the forum is the main channel with the chat for small questions + how to ask.

jkarinkl · 2024-03-06T15:08:41Z

Can this PR also be labeled 'Community: good first issue'?

kfessel · 2024-03-13T16:25:25Z

README.md

-Do you have a question, want to discuss a new feature, or just want to present
-your latest project using RIOT? Come over to our [forum] and post to your hearts
-content.
+## Asking for help


Suggested change

## Asking for help

## Community

### how to get in contact

forum, matrix, webpage

### Asking for help

You might already find your question answered in our forum or in an Gitub issue. You can search both of them.

mguetschow · 2024-10-29T19:46:10Z

@bergzand would you want to give this a final round?

bergzand · 2024-11-15T09:23:40Z

Rebased!

riot-ci · 2024-11-15T13:20:06Z

Murdock results

✔️ PASSED

c324ddf README: 📝 Rephrase forum into more generic help

Success	Failures	Total	Runtime
1	0	1	01m:21s

Artifacts

Documentation preview

README: Rephrase forum into more generic help

bergzand added Area: doc Area: Documentation CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Feb 22, 2024

bergzand requested review from OlegHahm, maribu and miri64 February 22, 2024 08:51

bergzand requested a review from jia200x as a code owner February 22, 2024 08:51

bergzand force-pushed the pr/asking_for_help branch from a28860d to 79f16b4 Compare February 22, 2024 08:56

waehlisch reviewed Feb 22, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

waehlisch reviewed Feb 22, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

waehlisch reviewed Feb 22, 2024

View reviewed changes

maribu added the Community: good first issue This issue is good for newcomers to RIOT to be addressed / implemented label Mar 6, 2024

kfessel reviewed Mar 13, 2024

View reviewed changes

Teufelchen1 approved these changes Nov 15, 2024

View reviewed changes

bergzand force-pushed the pr/asking_for_help branch from 8b930d3 to c4829ca Compare November 15, 2024 09:17

README: 📝 Rephrase forum into more generic help

c324ddf

bergzand force-pushed the pr/asking_for_help branch from c4829ca to c324ddf Compare November 15, 2024 09:23

Teufelchen1 enabled auto-merge November 15, 2024 09:32

bergzand added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Nov 15, 2024

Teufelchen1 added this pull request to the merge queue Nov 15, 2024

maribu removed this pull request from the merge queue due to the queue being cleared Nov 15, 2024

maribu added this pull request to the merge queue Nov 15, 2024

github-merge-queue bot pushed a commit that referenced this pull request Nov 15, 2024

Merge pull request #20413 from bergzand/pr/asking_for_help

e423fb7

README: Rephrase forum into more generic help

maribu removed this pull request from the merge queue due to the queue being cleared Nov 15, 2024

maribu added this pull request to the merge queue Nov 15, 2024

maribu removed this pull request from the merge queue due to the queue being cleared Nov 15, 2024

maribu added this pull request to the merge queue Nov 15, 2024

Merged via the queue into RIOT-OS:master with commit 1bb3745 Nov 16, 2024

MrKevinWeiss added this to the Release 2025.01 milestone Jan 20, 2025

-## Asking for help
+## Community
+### how to get in contact
+forum, matrix, webpage
+### Asking for help
+You might already find your question answered in our forum or in an Gitub issue. You can search both of them.

Conversation

bergzand commented Feb 22, 2024

Contribution description

Testing procedure

Issues/PRs references

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkarinkl commented Mar 6, 2024

Uh oh!

jkarinkl commented Mar 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mguetschow commented Oct 29, 2024

Uh oh!

bergzand commented Nov 15, 2024

Uh oh!

riot-ci commented Nov 15, 2024

Murdock results

Artifacts

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants