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.

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

[doc] Add Discord invite link alongside channel links #126352

Merged
merged 3 commits into from
Feb 13, 2025

Conversation

asb
Copy link
Contributor

@asb asb commented Feb 8, 2025

By far the most important part of this patch is updating GettingInvolved.rst to include the invite link, but I've grepped for any other discord.com links.

I'm no Discord expert, but from my experience (confirmed via @preames kindly testing as well) the direct channel links provide a confusing experience if you haven't already found and used an invite link to the LLVM Discord server. If you're logged into Discord but not a member of LLVM's sever, the web app opens and then...nothing. No channel opens, no prompt to join the server or even a hint that you need to find an invite link (and if you're not used to Discord, you likely don't even know that's necessary).

This patch addresses the issue by providing the invite link where Discord is mentioned.

By far the most important part of this patch is updating
GettingInvolved.rst to include the invite link, but I've grepped for
any other discord.com links.

I'm no Discord expert, but from my experience (confirmed via @preames
kindly testing as well) the direct channel links provide a confusing
experience if you haven't already found and used an invite link to the
LLVM Discord server. If you're logged into Discord, the web app opens
and then...nothing. No prompt to join the server or even a hint that you
need to find an invite link (and if you're not used to Discord, you may
not even know that's necessary).

This patch addresses the issue by providing the invite link where
Discord is mentioned.
@asb asb requested review from JDevlieghere and a team as code owners February 8, 2025 06:34
@llvmbot llvmbot added clang Clang issues not falling into any other category libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi. lldb libc labels Feb 8, 2025
@llvmbot
Copy link
Member

llvmbot commented Feb 8, 2025

@llvm/pr-subscribers-lldb
@llvm/pr-subscribers-clang

@llvm/pr-subscribers-libcxx

Author: Alex Bradbury (asb)

Changes

By far the most important part of this patch is updating GettingInvolved.rst to include the invite link, but I've grepped for any other discord.com links.

I'm no Discord expert, but from my experience (confirmed via @preames kindly testing as well) the direct channel links provide a confusing experience if you haven't already found and used an invite link to the LLVM Discord server. If you're logged into Discord, the web app opens and then...nothing. No channel opens, no prompt to join the server or even a hint that you need to find an invite link (and if you're not used to Discord, you likely don't even know that's necessary).

This patch addresses the issue by providing the invite link where Discord is mentioned.


Full diff: https://github.com/llvm/llvm-project/pull/126352.diff

5 Files Affected:

  • (modified) clang/www/OpenProjects.html (+1-1)
  • (modified) libc/docs/index.rst (+2-1)
  • (modified) libcxx/docs/index.rst (+1-1)
  • (modified) lldb/docs/index.rst (+2-1)
  • (modified) llvm/docs/GettingInvolved.rst (+1-1)
diff --git a/clang/www/OpenProjects.html b/clang/www/OpenProjects.html
index a9efdb8d762d763..6e32488b47b3381 100755
--- a/clang/www/OpenProjects.html
+++ b/clang/www/OpenProjects.html
@@ -149,7 +149,7 @@ <h1>Open Clang Projects</h1>
 <p>If you hit a bug with Clang, it is very useful for us if you reduce the code
 that demonstrates the problem down to something small. There are many ways to
 do this; ask on <a href="https://discourse.llvm.org/c/clang">Discourse</a>,
-<a href="https://discord.com/channels/636084430946959380/636725486533345280">Discord</a>
+<a href="https://discord.gg/xS7Z362">Discord</a>
 for advice.</p>
 
 </div>
diff --git a/libc/docs/index.rst b/libc/docs/index.rst
index 12dcba27a906bb7..f0e5c9db79b40d3 100644
--- a/libc/docs/index.rst
+++ b/libc/docs/index.rst
@@ -12,7 +12,8 @@ The LLVM C Library
   LLVM-libc is not fully complete right now. Some programs may fail to build due
   to missing functions. If you would like to help us finish LLVM-libc, check
   out "`Contributing to the libc project <contributing.html>`__" in the sidebar
-  or ask on `discord <https://discord.com/channels/636084430946959380/636732994891284500>`__.
+  or ask on `discord <https://discord.com/channels/636084430946959380/636732994891284500>`__
+  (`invite link <https://discord.gg/xS7Z362>`__).
 
 Introduction
 ============
diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 37912e9f8d03e6b..53c6b84c22ea7e4 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -242,5 +242,5 @@ Quick Links
 * `LLVM Bug Tracker <https://github.com/llvm/llvm-project/labels/libc++/>`_
 * `libcxx-commits Mailing List <http://lists.llvm.org/mailman/listinfo/libcxx-commits>`_
 * `libc++ forum <https://discourse.llvm.org/c/runtimes/libcxx/>`_
-* `libc++ chat <https://discord.com/channels/636084430946959380/636732894974312448>`_
+* `libc++ chat <https://discord.com/channels/636084430946959380/636732894974312448>`_ (`invite link <https://discord.gg/xS7Z362>`_)
 * `Browse libc++ Sources <https://github.com/llvm/llvm-project/tree/main/libcxx/>`_
diff --git a/lldb/docs/index.rst b/lldb/docs/index.rst
index 5686a33e94c9389..1ffdb08a1ca2cfe 100644
--- a/lldb/docs/index.rst
+++ b/lldb/docs/index.rst
@@ -182,7 +182,8 @@ interesting areas to contribute to lldb.
 
    Source Code <https://github.com/llvm/llvm-project>
    Releases <https://github.com/llvm/llvm-project/releases>
-   Discord <https://discord.com/channels/636084430946959380/636732809708306432>
+   Join the Discord <https://discord.gg/xS7Z362>
+   Discord Channel <https://discord.com/channels/636084430946959380/636732809708306432>
    Discussion Forums <https://discourse.llvm.org/c/subprojects/lldb/8>
    Developer Policy <https://llvm.org/docs/DeveloperPolicy.html>
    Bug Reports <https://github.com/llvm/llvm-project/issues?q=is%3Aissue+label%3Alldb+is%3Aopen>
diff --git a/llvm/docs/GettingInvolved.rst b/llvm/docs/GettingInvolved.rst
index 99e8d1e46738483..d3663491766c20b 100644
--- a/llvm/docs/GettingInvolved.rst
+++ b/llvm/docs/GettingInvolved.rst
@@ -392,7 +392,7 @@ Discord
 -------
 
 Users and developers of the LLVM project (including subprojects such as Clang)
-can be found on the community's `Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_
+can be found on the community's `Discord <https://discord.gg/xS7Z362>`_
 chat server. The server is actively moderated.
 
 The #buildbot-status channel has a bot for

@llvmbot
Copy link
Member

llvmbot commented Feb 8, 2025

@llvm/pr-subscribers-libc

Author: Alex Bradbury (asb)

Changes

By far the most important part of this patch is updating GettingInvolved.rst to include the invite link, but I've grepped for any other discord.com links.

I'm no Discord expert, but from my experience (confirmed via @preames kindly testing as well) the direct channel links provide a confusing experience if you haven't already found and used an invite link to the LLVM Discord server. If you're logged into Discord, the web app opens and then...nothing. No channel opens, no prompt to join the server or even a hint that you need to find an invite link (and if you're not used to Discord, you likely don't even know that's necessary).

This patch addresses the issue by providing the invite link where Discord is mentioned.


Full diff: https://github.com/llvm/llvm-project/pull/126352.diff

5 Files Affected:

  • (modified) clang/www/OpenProjects.html (+1-1)
  • (modified) libc/docs/index.rst (+2-1)
  • (modified) libcxx/docs/index.rst (+1-1)
  • (modified) lldb/docs/index.rst (+2-1)
  • (modified) llvm/docs/GettingInvolved.rst (+1-1)
diff --git a/clang/www/OpenProjects.html b/clang/www/OpenProjects.html
index a9efdb8d762d763..6e32488b47b3381 100755
--- a/clang/www/OpenProjects.html
+++ b/clang/www/OpenProjects.html
@@ -149,7 +149,7 @@ <h1>Open Clang Projects</h1>
 <p>If you hit a bug with Clang, it is very useful for us if you reduce the code
 that demonstrates the problem down to something small. There are many ways to
 do this; ask on <a href="https://discourse.llvm.org/c/clang">Discourse</a>,
-<a href="https://discord.com/channels/636084430946959380/636725486533345280">Discord</a>
+<a href="https://discord.gg/xS7Z362">Discord</a>
 for advice.</p>
 
 </div>
diff --git a/libc/docs/index.rst b/libc/docs/index.rst
index 12dcba27a906bb7..f0e5c9db79b40d3 100644
--- a/libc/docs/index.rst
+++ b/libc/docs/index.rst
@@ -12,7 +12,8 @@ The LLVM C Library
   LLVM-libc is not fully complete right now. Some programs may fail to build due
   to missing functions. If you would like to help us finish LLVM-libc, check
   out "`Contributing to the libc project <contributing.html>`__" in the sidebar
-  or ask on `discord <https://discord.com/channels/636084430946959380/636732994891284500>`__.
+  or ask on `discord <https://discord.com/channels/636084430946959380/636732994891284500>`__
+  (`invite link <https://discord.gg/xS7Z362>`__).
 
 Introduction
 ============
diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 37912e9f8d03e6b..53c6b84c22ea7e4 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -242,5 +242,5 @@ Quick Links
 * `LLVM Bug Tracker <https://github.com/llvm/llvm-project/labels/libc++/>`_
 * `libcxx-commits Mailing List <http://lists.llvm.org/mailman/listinfo/libcxx-commits>`_
 * `libc++ forum <https://discourse.llvm.org/c/runtimes/libcxx/>`_
-* `libc++ chat <https://discord.com/channels/636084430946959380/636732894974312448>`_
+* `libc++ chat <https://discord.com/channels/636084430946959380/636732894974312448>`_ (`invite link <https://discord.gg/xS7Z362>`_)
 * `Browse libc++ Sources <https://github.com/llvm/llvm-project/tree/main/libcxx/>`_
diff --git a/lldb/docs/index.rst b/lldb/docs/index.rst
index 5686a33e94c9389..1ffdb08a1ca2cfe 100644
--- a/lldb/docs/index.rst
+++ b/lldb/docs/index.rst
@@ -182,7 +182,8 @@ interesting areas to contribute to lldb.
 
    Source Code <https://github.com/llvm/llvm-project>
    Releases <https://github.com/llvm/llvm-project/releases>
-   Discord <https://discord.com/channels/636084430946959380/636732809708306432>
+   Join the Discord <https://discord.gg/xS7Z362>
+   Discord Channel <https://discord.com/channels/636084430946959380/636732809708306432>
    Discussion Forums <https://discourse.llvm.org/c/subprojects/lldb/8>
    Developer Policy <https://llvm.org/docs/DeveloperPolicy.html>
    Bug Reports <https://github.com/llvm/llvm-project/issues?q=is%3Aissue+label%3Alldb+is%3Aopen>
diff --git a/llvm/docs/GettingInvolved.rst b/llvm/docs/GettingInvolved.rst
index 99e8d1e46738483..d3663491766c20b 100644
--- a/llvm/docs/GettingInvolved.rst
+++ b/llvm/docs/GettingInvolved.rst
@@ -392,7 +392,7 @@ Discord
 -------
 
 Users and developers of the LLVM project (including subprojects such as Clang)
-can be found on the community's `Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_
+can be found on the community's `Discord <https://discord.gg/xS7Z362>`_
 chat server. The server is actively moderated.
 
 The #buildbot-status channel has a bot for

Copy link
Collaborator

@preames preames left a comment

Choose a reason for hiding this comment

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

LGTM w/requested change.

Another option would be to expand a section on joining discord somewhere, and then scatter links to that in the docs instead of the invite link itself.

@@ -149,7 +149,7 @@ <h1>Open Clang Projects</h1>
<p>If you hit a bug with Clang, it is very useful for us if you reduce the code
that demonstrates the problem down to something small. There are many ways to
do this; ask on <a href="https://discourse.llvm.org/c/clang">Discourse</a>,
<a href="https://discord.com/channels/636084430946959380/636725486533345280">Discord</a>
<a href="https://discord.gg/xS7Z362">Discord</a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you keep the channel link for this one, and add the invite?

Copy link
Member

@mordante mordante left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM!

@@ -12,7 +12,8 @@ The LLVM C Library
LLVM-libc is not fully complete right now. Some programs may fail to build due
to missing functions. If you would like to help us finish LLVM-libc, check
out "`Contributing to the libc project <contributing.html>`__" in the sidebar
or ask on `discord <https://discord.com/channels/636084430946959380/636732994891284500>`__.
or ask on `discord <https://discord.com/channels/636084430946959380/636732994891284500>`__
(`invite link <https://discord.gg/xS7Z362>`__).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Overall LGTM, but maybe this could be spelled more explicitly, something around the words "one need to join Discord using this invite link first" or something like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about "or ask on Discord (join via this invite link)" (obviously with the relevant links added!).

@DavidSpickett
Copy link
Collaborator

I also looked at this but got into a rabbit hole finding out whether you could have channel specific invites. I think you can, but I don't think it actually helps us. As the other problem we have had is invites expiring, so the fewer unique invite links the better.

Copy link
Collaborator

@AaronBallman AaronBallman left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@michaelrj-google michaelrj-google left a comment

Choose a reason for hiding this comment

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

LGTM from the libc side

@chandlerc chandlerc removed their request for review February 12, 2025 23:14
@asb asb merged commit db2953d into llvm:main Feb 13, 2025
18 of 24 checks passed
joaosaffran pushed a commit to joaosaffran/llvm-project that referenced this pull request Feb 14, 2025
By far the most important part of this patch is updating
GettingInvolved.rst to include the invite link, but I've grepped for any
other discord.com links.

I'm no Discord expert, but from my experience (confirmed via @preames
kindly testing as well) the direct channel links provide a confusing
experience if you haven't already found and used an invite link to the
LLVM Discord server. If you're logged into Discord but not a member of
LLVM's sever, the web app opens and then...nothing. No channel opens, no
prompt to join the server or even a hint that you need to find an invite
link (and if you're not used to Discord, you likely don't even know
that's necessary).

This patch addresses the issue by providing the invite link where
Discord is mentioned.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category documentation libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi. libc lldb
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants