README.md: update Discord channel instructions #9762
Conversation
DaveLak
requested review from
lgirdwood,
plbossart,
mmaka1,
lbetlej,
dbaluta and
kv2019i
as code owners
|
Can one of the admins verify this patch?
|
There was a problem hiding this comment.
Thank you @DaveLak for the patch! This seems more future proof to link to Zephyr documentation.
Can you fix the commit message style to match the project style? See warnings in https://github.com/thesofproject/sof/actions/runs/12594094785/job/35107352776?pr=9762 and some examples with "git log README.md".. E.g. title should be Linxu kernel style "README.md: replace invalid Discord link" and body kept within 75 chars per line. Otherwise looks good to go.
|
While at it, please fix the commit subject and message: the link is not "invalid". I just tried it again and it works perfectly fine... when you have already been invited. So, not "invalid" but "restricted access" |
Replace the direct #sof Discord channel link with a reference to the Zephyr project's documentation for accessing their server, where the channel is hosted. The previous link only worked for users already in the Zephyr Discord server, potentially confusing new visitors looking to join the channel. Pointing to Zephyr's community docs provides the necessary context and instructions for getting an invite to access the #sof channel. Since the channel is part of Zephyr’s Discord server, directing readers to their official documentation ensures the instructions remain accurate while sparing this project from duplicating details. Fixes GitHub issue thesofproject#7161. Signed-off-by: David Lakin <[email protected]>
DaveLak
changed the title
|
Thank you for the review and feedback, @kv2019i and @marc-hb! I've updated the commit message to address the requested changes. Apologies for the oversight on my part! It’s funny because I’m usually rather meticulous about commit messages, but this was one of the rare cases where I used the GH browser UI, and I suppose the informal nature of the process was reflected in the message. Lesson learned! 🙂 |
Replace the direct #sof Discord channel link with a reference to the
Zephyr project's documentation for accessing their server, where the
channel is hosted.
The previous link only worked for users already in the Zephyr Discord
server, potentially confusing new visitors looking to join the channel.
Pointing to Zephyr's community docs provides the necessary context and
instructions for getting an invite to access the #sof channel.
Since the channel is part of Zephyr’s Discord server, directing readers
to their official documentation ensures the instructions remain accurate
while sparing this project from duplicating details.
Fixes GitHub issue #7161.