Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Improvements around Code of Conduct #21071

Merged
merged 7 commits into from
Dec 16, 2024
Merged

doc: Improvements around Code of Conduct #21071

merged 7 commits into from
Dec 16, 2024

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Dec 10, 2024

Contribution description

This moves

  • Some wiki pages related to our code of conduct (reporting guidelines and FAQ) to our documentation,
  • Adds the Code of Conduct itself to the documentation (as a copy of CODE_OF_CONDUCT.md), and
  • Provides an overview over all of these pages as a new “Code of Conduct Information” page. The main purpose of the latter is so all of them are collected under one group in the Doxygen side bar.

Testing procedure

Read the results generated by Murdock.

Issues/PRs references

None

@github-actions github-actions bot added the Area: doc Area: Documentation label Dec 10, 2024
@miri64 miri64 mentioned this pull request Dec 10, 2024
Merged
@miri64 miri64 added CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation labels Dec 10, 2024
@riot-ci
Copy link

riot-ci commented Dec 10, 2024 •
edited
Loading

Murdock results

✔️ PASSED

e96211f coc-faq.md: Enforce 80 column formatting.

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

Artifacts

mguetschow
mguetschow approved these changes Dec 16, 2024
View reviewed changes
Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked the generated documentation at this deeplink: https://ci.riot-os.org/results/4efbd5afc4e74cb69f98212986e6ff8b/doc-preview/coc-info.html

Looks good to me, but maybe we want to have more than one ACK on this one.

@miri64 @mguetschow
coc-faq.md: update to current state
544ae78 
Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de>
@miri64
Copy link
Member Author

miri64 commented Dec 16, 2024

Looks good to me, but maybe we want to have more than one ACK on this one.

This PR just moves files around. Do we really need more ACKs for this?

maribu
maribu approved these changes Dec 16, 2024
View reviewed changes
@miri64 @maribu
coc-faq.md: Enforce 80 column formatting.
e96211f 
Co-authored-by: Marian Buschsieweke <maribu@users.noreply.github.com>
@miri64 miri64 enabled auto-merge December 16, 2024 12:16
@miri64 miri64 added this pull request to the merge queue Dec 16, 2024
Merged via the queue into RIOT-OS:master with commit 234b81b Dec 16, 2024
25 checks passed
@miri64 miri64 deleted the doc/enh/coc branch December 16, 2024 12:58
@mguetschow
Copy link
Contributor

Thanks @miri64 !

@mguetschow
Copy link
Contributor

Should we go on and remove the Wiki pages (or rather link to the documentation pages instead)?

@miri64 miri64 mentioned this pull request Dec 16, 2024
Merged
@miri64
Copy link
Member Author

miri64 commented Dec 16, 2024

Should we go on and remove the Wiki pages (or rather link to the documentation pages instead)?

Done in the same style I removed all the other pages I moved to the doc in the past few weeks: https://github.com/RIOT-OS/RIOT/wiki/_history

@MrKevinWeiss MrKevinWeiss added this to the Release 2025.01 milestone Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maribu maribu maribu approved these changes

@mguetschow mguetschow mguetschow approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees
No one assigned
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Projects
None yet
Milestone
Release 2025.01
Development

Successfully merging this pull request may close these issues.
5 participants
@miri64 @riot-ci @mguetschow @maribu @MrKevinWeiss