llvm-project/llvm/docs/DiscourseMigrationGuide.md

12 KiB

Discourse Migration Guide

Current Status of Migration: Discourse is back online at a new URL: https://discourse.llvm.org. The old one still works as well. We are aware of an issue with reply by email to emails from before the merge. We will update once we know more.

This document is intended to help LLVM users to migrate from the mailing lists to Discourse. Discourse has two basic ways for interaction: Via the web UI and via emails.

Setting up your account

The easiest way is to create an account using your GitHub account:

  1. Navigate to https://llvm.discourse.group/
  2. Click on "Sign Up" in the top right corner.
  3. Choose "With GitHub" on the right side and log in with your GitHub account.

Structure of Discourse

Discourse's structure is similar to a set of mailing lists, however different terms are used there. To help with the transition, here's a translation table for the terms:

Mailing listDiscourse
Mailing list, consists of threadscategory, consists of topics
thread, consists of emailstopic, consists of posts
emailpost

Setting up email interactions

Some folks want to interact with Discourse purely via their email program. Here are the typical use cases:

  • You can subscribe to a category or topic
  • You can reply to a post, including quoting other peoples texts (tested on GMail).
  • Quoting previous topics in an reply
  • You can filter incoming emails in your email client by category using the List-ID email header field.
  • You can create topics through email using the email address that is specific to the category. Each category description shows the email address to use, or you can use the mapping below.

Mapping of email addresses to Discourse categories

Use these email addresses to create a topic by email in the specific discourse category. You must have a Discourse account associated with the email address you are sending from or the email will be rejected.

Discourse CategoryEmail Address
Beginnerbeginners@discourse.llvm.org
LLVM Projectllvmproject@discourse.llvm.org
IR & OptimizationsIR.Optimizations@discourse.llvm.org
IR & Optimizations - Loop OptimizationsIR.Optimizations-Loops@discourse.llvm.org
Code Generationcodegen@discourse.llvm.org
Code Generation - AMDGPUcodegen-amdgpu@discourse.llvm.org
Code Generation - Common Infrastructurecodegen-common@discourse.llvm.org
Code Generation - AArch64codegen-aarch64@discourse.llvm.org
Code Generation - Armcodegen-arm@discourse.llvm.org
Code Generation - PowerPCcodegen-powerpc@discourse.llvm.org
Code Generation - RISCVcodegen-riscv@discourse.llvm.org
Code Generation - WebAssemblycodegen-webassembly@discourse.llvm.org
Code Generation - X86codegen-x86@discourse.llvm.org
Clang Frontendclang@discourse.llvm.org
Clang Frontend - Using Clangclang-users@discourse.llvm.org
Clang Frontend - clangdclangd@discourse.llvm.org
Clang Frontend - Building Clangclang-build@discourse.llvm.org
Clang Frontend - Static Analyzerclang-staticanalyzer@discourse.llvm.org
Runtimesruntimes@discourse.llvm.org
Runtimes - C++runtimes-cxx@discourse.llvm.org
Runtimes - Sanitizersruntimes-sanitizers@discourse.llvm.org
Runtimes - Cruntimes-c@discourse.llvm.org
Runtimes - OpenMPruntimes-openmp@discourse.llvm.org
Runtimes - OpenCLruntimes-opencl@discourse.llvm.org
MLIRmlir@discourse.llvm.org
MLIR - Announcemlir-announce@discourse.llvm.org
MLIR - Newslettermlir-news@discourse.llvm.org
MLIR - TCP-WGmlir-tcpwg@discourse.llvm.org
Subprojectssubprojects@discourse.llvm.org
Subprojects - Pollypolly@discourse.llvm.org
Subprojects - LLDBlldb@discourse.llvm.org
Subprojects - LLDlld@discourse.llvm.org
Subprojects - Flang flang@discourse.llvm.org
Subprojects - Boltbolt@discourse.llvm.org
Project Infrastructureinfra@discourse.llvm.org
Project Infrastructure - Release Testersinfra-release-testers@discourse.llvm.org
Project Infrastructure - Websiteinfra-website@discourse.llvm.org
Project Infrastructure - Documentation infra-docs@discourse.llvm.org
Project Infrastructure - GitHubinfra-github@discourse.llvm.org
Project Infrastructure - Code Reviewinfra-codereview@discourse.llvm.org
Project Infrastructure - Discordinfra-discord@discourse.llvm.org
Project Infrastructure - Mailing Lists and Forumsinfra-mailinglists@discourse.llvm.org
Project Infrastructure - IRC infra-irc@discourse.llvm.org
Project Infrastructure - Infrastructure Working Groupinfra-iwg@discourse.llvm.org
Communitycommunity@discourse.llvm.org
Community - Women in Compilers and Toolswict@discourse.llvm.org
Community - Job Postingscommunity-jobs@discourse.llvm.org
Community - US LLVM Developers' Meetingdevmtg-US@discourse.llvm.org
Community - EuroLLVMdevmtg-euro@discourse.llvm.org
Community - GSOCgsoc@discourse.llvm.org
Community - Community.ocommunity-dot-o@discourse.llvm.org
Community - LLVM Foundationfoundation@discourse.llvm.org
Community - Newslettersnewsletters@discourse.llvm.org
Incubatorincubator@discourse.llvm.org
Incubator - CIRCTcirct@discourse.llvm.org
Incubator - Torch-MLIRtorch-mlir@discourse.llvm.org
Incubator - Enzymeenzyme@discourse.llvm.org
Feedbackfeedback@discourse.llvm.org

Mapping of mailing lists to categories

This table explains the mapping from mailing lists to categories in Discourse. The email addresses of these categories will remain the same, after the migration. Obsolete lists will become read-only as part of the Discourse migration.

Mailing listsCategory in Discourse
All-commitsno migration at the moment
Bugs-adminno migration at the moment
cfe-commitsno migration at the moment
cfe-devClang Frontend
cfe-usersClang Frontend/Using Clang
clangd-devClang Frontend/clangd
devmtg-organizersObsolete
DocsObsolete
eurollvm-organizersObsolete
flang-commitsno migration at the moment
flang-devSubprojects/Flang Fortran Frontend
gsocObsolete
libc-commitsno migration at the moment
libc-devRuntimes/C
Libclc-devRuntimes/OpenCL
libcxx-bugsno migration at the moment
libcxx-commitsno migration at the moment
libcxx-devRuntimes/C++
lldb-commitsno migration at the moment
lldb-devSubprojects/lldb
llvm-adminno migration at the moment
llvm-announceAnnounce
llvm-branch-commitsno migration at the moment
llvm-bugsno migration at the moment
llvm-commitsno migration at the moment
llvm-devProject Infrastructure/LLVM Dev List Archives
llvm-devmeetingCommunity/US Developer Meeting
llvm-foundationCommunity/LLVM Foundation
Mlir-commitsno migration at the moment
Openmp-commitsno migration at the moment
Openmp-devRuntimes/OpenMP
Parallel_libs-commitsno migration at the moment
Parallel_libs-devRuntimes/C++
Release-testersProject Infrastructure/Release Testers
Test-listObsolete
vmkit-commitsObsolete
WiCTCommunity/Women in Compilers and Tools
www-scriptsObsolete

FAQ

I don't want to use a web UI

You can do most of the communication with your email client (see section on Setting up email interactions above). You only need to set up your account once and then configure which categories you want to subscribe to.

How do I send a private message?

On the mailing list you have the opportunity to reply only to the sender of the email, not to the entire list. That is not supported when replying via email on Discourse. However you can send someone a private message via the Web UI: Click on the user's name above a post and then on Message.

Also Discourse does not expose users' email addresses , so your private replies have to go through their platform (unless you happen to know the email address of the user.)

How can my script/tool send automatic messages?**

In case you want to create a new post/topic automatically from a script or tool, you can use the Discourse API.

Who are the admins for Discourse?

See https://llvm.discourse.group/about

What is the reason for the migration?

See this email

How do I set up a private mailing list?

If needed categories can have individual security settings to limit visibility and write permissions. Contact the admins if you need such a category.

What will happen to our email archives?

The Mailman archives will remain on the web server for now.

What are advantages of Discourse over the current mailing lists?

  • Users can post to any category, also without being subscribed.
  • Full text search on the Web UI.
  • Sending/replying via the Web UI (email is still possible).
  • View entire thread on one page.
  • Categories are a more light-weight option to structure the discussions than creating new mailing lists.
  • Single sign on with GitHub.
  • User email addresses are kept private.

I have another question not covered here. What should I do?

Please contact iwg@llvm.org or raise a ticket on GitHub.