Skip to content

Commit bd93e28

Browse files
authored
Merge pull request #21708 from AnnsAnns/more_migration
doc/guides: The Big Migration
2 parents f72ddd7 + ae420f6 commit bd93e28

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+4355
-3398
lines changed

CODE_OF_CONDUCT.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ affect a person's ability to participate within them.
2222

2323
If you believe someone is violating the code of conduct, we ask that you report
2424
it by emailing <[email protected]>. For more details please see our [Reporting
25-
Guidelines](https://doc.riot-os.org/coc-reporting-guide.html).
25+
Guidelines][reporting-guidelines].
2626

2727
- **Be friendly and patient.**
2828
- **Be welcoming.** We strive to be a community that welcomes and supports
@@ -39,7 +39,7 @@ Guidelines](https://doc.riot-os.org/coc-reporting-guide.html).
3939
- **Be respectful.** Not all of us will agree all the time, but disagreement
4040
is no excuse for poor behavior and poor manners. We might all experience
4141
some frustration now and then, but we cannot allow that frustration to turn
42-
into a personal attack. Its important to remember that a community where
42+
into a personal attack. It's important to remember that a community where
4343
people feel uncomfortable or threatened is not a productive one. Members of
4444
the RIOT community should be respectful when dealing with other members as
4545
well as with people outside the RIOT community.
@@ -61,18 +61,23 @@ Guidelines](https://doc.riot-os.org/coc-reporting-guide.html).
6161
- **When we disagree, try to understand why.** Disagreements, both social and
6262
technical, happen all the time and RIOT is no exception. It is important
6363
that we resolve disagreements and differing views constructively. Remember
64-
that were different. The strength of RIOT comes from its varied community,
64+
that we're different. The strength of RIOT comes from its varied community,
6565
people from a wide range of backgrounds. Different people have different
6666
perspectives on issues. Being unable to understand why someone holds a
67-
viewpoint doesnt mean that theyre wrong. Dont forget that it is human to
68-
err and blaming each other doesnt get us anywhere. Instead, focus on
67+
viewpoint doesn't mean that they're wrong. Don't forget that it is human to
68+
err and blaming each other doesn't get us anywhere. Instead, focus on
6969
helping to resolve issues and learning from mistakes.
7070

7171
Text based on the Code of Conduct of the [Django
72-
community](https://www.djangoproject.com/conduct/).
72+
community][django-community].
7373

7474
Questions?
7575
----------
7676

77-
If you have questions, please see [the FAQ](https://doc.riot-os.org/coc-faq.html).
78-
If that doesn't answer your questions, feel free to [contact us](mailto:[email protected]).
77+
If you have questions, please see [the FAQ][faq].
78+
If that doesn't answer your questions, feel free to [contact us][contact-us].
79+
80+
[reporting-guidelines]: https://guide.riot-os.org/general/code_of_conduct/reporting/
81+
[django-community]: https://www.djangoproject.com/conduct/
82+
[faq]: https://guide.riot-os.org/general/code_of_conduct/faq/
83+
[contact-us]: mailto:[email protected]

doc/doxygen/riot.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2618,7 +2618,7 @@ DOT_PATH =
26182618
# command).
26192619
# This tag requires that the tag HAVE_DOT is set to YES.
26202620

2621-
DOTFILE_DIRS = dot/
2621+
DOTFILE_DIRS =
26222622

26232623
# The MSCFILE_DIRS tag can be used to specify one or more directories that
26242624
# contain msc files that are included in the documentation (see the \mscfile

doc/doxygen/src/advanced-build-system-tricks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Advanced build system tricks {#advanced-build-system-tricks}
1+
Advanced build system tricks (Deprecated) {#advanced-build-system-tricks}
22
============================
33

44
@deprecated See [Advanced Build System Tricks](https://guide.riot-os.org/build-system/advanced_build_system_tricks/)

doc/doxygen/src/build-in-docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Build In Docker {#build-in-docker}
1+
# Build In Docker (Deprecated) {#build-in-docker}
22

33
@deprecated This page is deprecated.
44
See [Build in Docker](https://guide.riot-os.org/build-system/build-in-docker/)

doc/doxygen/src/build-system-basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Build System Basics {#build-system-basics}
1+
# Build System Basics (Deprecated) {#build-system-basics}
22

33
@deprecated See [Build System Basics](https://guide.riot-os.org/build-system/build_system_basics/)
44
on the RIOT Guide Site for the latest information.

doc/doxygen/src/coc-faq.md

Lines changed: 3 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,4 @@
1-
# FAQ {#coc-faq}
1+
# FAQ (Deprecated) {#coc-faq}
22

3-
This FAQ attempts to address common questions and concerns around the RIOT
4-
community's [Code of Conduct][CoC]. If you still have questions after
5-
reading it, please feel free to [contact us][CoC-question-mail].
6-
7-
--------------------------------------------------------------------------------
8-
9-
### Why have you adopted a Code of Conduct?
10-
11-
If you're familiar with the RIOT
12-
community, you'll probably notice that the Code basically matches what we
13-
already do. Think of this as documentation: we're taking implicit expectations
14-
about behavior and making them explicit.
15-
16-
We're doing this because the RIOT community is growing faster than any of us
17-
could have anticipated. This is on balance a very positive thing, but as we've
18-
grown past the point where it's possible to know the whole community we think
19-
it's very important to be clear about our values.
20-
21-
We know that the RIOT community is open, friendly, and welcoming. We want to
22-
make sure everyone else knows it too.
23-
24-
### What does it mean to "adopt" a Code of Conduct?
25-
26-
For the most part, we don't think it means large changes. We think that the text
27-
does a really good job describing the way the RIOT community already conducts
28-
itself. We expect that most people will simply continue to behave in the awesome
29-
way they have for years.
30-
31-
However, we do expect that people will abide by the spirit and words of the CoC
32-
when in "official" RIOT spaces. This code has been adopted by the RIOT community
33-
as a whole. That means that it'll apply in all community spaces.
34-
35-
In practice, this means the [RIOT forum](https://forum.riot-os.org), the Matrix
36-
chats (e.g., [`#riot-os`](https://matrix.to/#/#riot-os:matrix.org) or
37-
[`#riot-os-off-topic`](https://matrix.to/#/#riot-os-off-topic:matrix.org)),
38-
mailing lists (e.g., [email protected]), bug tracking and code review tools,
39-
and "official" RIOT events such as Hack'n'ACKs or RIOT summits. In addition,
40-
violations of this code outside these spaces may affect a person's ability to
41-
participate within them.
42-
43-
### What happens if someone violates the Code of Conduct?
44-
45-
Our intent is that anyone in the community can stand up for this code, and
46-
direct people who're unaware to this document. If that doesn't work, or if you
47-
need more help, you can contact <[email protected]>. For more details please see
48-
our [Reporting Guidelines](@ref coc-reporting-guide).
49-
50-
### Why do we need a Code of Conduct? Everyone knows not to be a jerk.
51-
52-
Sadly, not everyone knows this.
53-
54-
However, even if everyone was kind, everyone was compassionate, and everyone was
55-
familiar with codes of conduct it would still be incumbent upon our community to
56-
publish our own. Maintaining a code of conduct forces us to consider and
57-
articulate what kind of community we want to be, and serves as a constant
58-
reminder to put our best foot forward. But most importantly, it serves as a
59-
signpost to people looking to join our community that we feel these values are
60-
important.
61-
62-
### This is censorship! I have the right to say whatever I want!
63-
64-
You do -- in *your* space. If you'd like to hang out in *our* spaces (as
65-
clarified above), we have some simple guidelines to follow. If you want to, for
66-
example, form a group where RIOT is discussed using language inappropriate for
67-
general channels then nobody's stopping you. We respect your right to establish
68-
whatever codes of conduct you want in the spaces that belong to you. Please
69-
honor this Code of Conduct in our spaces.
70-
71-
#### References
72-
This FAQ was adapted from the [Django Code of Conduct FAQ](https://www.djangoproject.com/conduct/faq/)
73-
74-
[CoC-question-mail]: mailto:[email protected]
75-
[CoC]: @ref coc
3+
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/faq/).
4+
This page will be removed after release 2026.04.

doc/doxygen/src/coc-info.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
Code of Conduct Information {#coc-info}
1+
Code of Conduct Information (Deprecated) {#coc-info}
22
===========================
33

4-
The following documents are describing all matters around our code of conduct:
5-
6-
- The \subpage coc itself,
7-
- The \subpage coc-reporting-guide, and
8-
- The \subpage coc-faq
4+
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/).
5+
This page will be removed after release 2026.04.
Lines changed: 3 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,4 @@
1-
# Reporting Guidelines {#coc-reporting-guide}
1+
# Reporting Guidelines (Deprecated) {#coc-reporting-guide}
22

3-
If you believe someone is violating the [code of conduct][CoC] we ask that you
4-
report it to us by emailing <[email protected]>. Currently, the recipients of
5-
this email address are [\@OlegHahm](https://github.com/OlegHahm) (Oleg Hahm) and
6-
[\@miri64](https://github.com/miri64) (Martine Lenders).
7-
8-
**All reports will be kept confidential.** In some cases we may determine that a
9-
public statement will need to be made. If that's the case, the identities of all
10-
victims and reporters will remain confidential unless those individuals instruct
11-
us otherwise.
12-
13-
**If you believe anyone is in physical danger, please notify appropriate law
14-
enforcement first.** If you are unsure what law enforcement agency is
15-
appropriate, please include this in your report and we will attempt to notify
16-
them.
17-
18-
If you are unsure whether the incident is a violation, or whether the space
19-
where it happened is covered by this Code of Conduct, we encourage you to still
20-
report it. We would much rather have a few extra reports where we decide to take
21-
no action, rather than miss a report of an actual violation. We do not look
22-
negatively on you if we find the incident is not a violation. And knowing about
23-
incidents that are not violations, or happen outside our spaces, can also help
24-
us to improve the Code of Conduct or the processes surrounding it.
25-
26-
In your report please include:
27-
28-
- Your contact info (so we can get in touch with you if we need to follow up)
29-
- Names (real, nicknames, or pseudonyms) of any individuals involved. If there
30-
were other witnesses besides you, please try to include them as well.
31-
- When and where the incident occurred. Please be as specific as possible.
32-
- Your account of what occurred. If there is a publicly available record (e.g.
33-
forum post, a mailing list archive, or a public Matrix chat link) please include a link.
34-
- Any extra context you believe existed for the incident.
35-
- If you believe this incident is ongoing.
36-
- Any other information you believe we should have.
37-
38-
### What happens after you file a report?
39-
40-
You will receive an email from one of the core community members as soon as
41-
possible. We promise to acknowledge receipt within 24 hours (and will aim for
42-
much quicker than that).
43-
44-
They will review the incident and determine:
45-
46-
- What happened.
47-
- Whether this event constitutes a code of conduct violation.
48-
- Who the bad actor was.
49-
- Whether this is an ongoing situation, or if there is a threat to anyone's
50-
physical safety.
51-
52-
If this is determined to be an ongoing incident or a threat to physical safety,
53-
their immediate priority will be to protect everyone involved.
54-
This means we may delay an "official" response until we believe that the
55-
situation has ended and that everyone is physically safe.
56-
57-
Once the working group has a complete account of the events they will make a
58-
decision as to how to response. Responses may include:
59-
60-
- Nothing (if we determine no violation occurred).
61-
- A private reprimand from us to the individual(s) involved.
62-
- A public reprimand.
63-
- An imposed vacation (i.e. asking someone to "take a week off" from the forum, the Matrix chats, or a mailing
64-
list).
65-
- A permanent or temporary ban from some or all RIOT spaces (forum, Matrix chats, mailing lists,
66-
etc.)
67-
- A request for a public or private apology.
68-
69-
We'll respond within one week to the person who filed the report with either a
70-
resolution or an explanation of why the situation is not yet resolved.
71-
72-
Once we've determined our final action, we'll contact the original reporter to
73-
let them know what action (if any) we'll be taking. We'll take into account
74-
feedback from the reporter on the appropriateness of our response, but we don't
75-
guarantee we'll act on it.
76-
77-
#### Reference
78-
These reporting guidelines were adapted from the [Django reporting guidelines](https://www.djangoproject.com/conduct/reporting/)
79-
80-
[CoC]: @ref coc
3+
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/reporting/).
4+
This page will be removed after release 2026.04.

0 commit comments

Comments
 (0)