[docs][material] Revise the Support page #38207

samuelsycamore · 2023-07-28T19:44:29Z

revised copy throughout
removed emoji from headers
removed Blog link - we don't really offer any "support" there per se
revised CTA for Twitter/social media
removed Supported Versions sections - not sure why that's here
removed a lot of unnecessary text attempting to justify why MUI X is a paid product 😅
~~removed Custom Work section - nobody's got time for that!~~
added Discord section

https://deploy-preview-38207--material-ui.netlify.app/material-ui/getting-started/support/

mui-bot · 2023-07-28T19:47:33Z

Netlify deploy preview

docs/data/material/getting-started/support/support.md

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against cd19cb1

oliviertassinari

We can already add Discord https://mui.com/r/discord/ invitation link in this page, no? cc @richbustos

oliviertassinari · 2023-07-28T20:18:13Z

docs/data/material/getting-started/support/support.md

-
-[Post a question](https://stackoverflow.com/questions/tagged/mui)
+[Stack Overflow](https://stackoverflow.com/) contains a wealth of information about Material UI and other MUI products, spanning many years and countless discussion threads.
+Head here to see if your problem has already been resolved by the community, or else [post a question](https://stackoverflow.com/questions/tagged/mui) to get help from community experts as well as MUI maintainers.


Suggested change

Head here to see if your problem has already been resolved by the community, or else [post a question](https://stackoverflow.com/questions/tagged/mui) to get help from community experts as well as MUI maintainers.

Head here to see if your problem has already been resolved by the community, or else [post a question](https://stackoverflow.com/questions/tagged/material-ui) to get help from community experts as well as MUI maintainers.

We can already add Discord https://mui.com/r/discord/ invitation link in this page, no? cc @richbustos

We sure can. Just tested and it seems to work. Discord is ready, with no blockers. I am working on an announcement plan. We were thinking of adding it to the newsletter as well. CC: @samuelsycamore

I was thinking more about this page, and in hindsight, https://master--material-ui.netlify.app/material-ui/getting-started/support/ feels very strange, Discord is the worst place possible to get support. I'm proposing we remove it from this part of the docs in https://github.com/mui/material-ui/pull/38423/files#r1291343128.

Maybe we should have a page like https://nextjs.org/docs/community where we guide people to Discord.

Discord is the worst place possible to get support.

Really? I thought that was a big part of its appeal. 😅 I guess we need to get better alignment on this.

A Community page sounds a like a good idea to me, but then this Support page is just stuff about MUI X, TideLift, and the Custom Work part—and then I wonder if this page should even exist at all in the Material UI docs.

Discord is the worst place possible to get support.

While I don't fully agree on this statement, we should have UXR data to back up our hypothesis.

I thought that was a big part of its appeal.

I meant for the Q&A kind of support, the one developers face the most often, who has time to go to Discord to ask for help for a problem you are facing? It feels so inefficient.

The problems we solve with Discord are listed in https://www.notion.so/mui-org/Create-a-Discord-server-584d615371e542de9faf781ed252cf39?pvs=4#d57671ff8af342a18f2338c53462595d, I think it's:

Maintainers <> Contributors collaboration (product research)

Moving Slack to a company-paid plan

Allowing engaged Material UI users to belong

I wonder if this page should even exist at all in the Material UI docs.

For the general docs, I think it can be great, same for a community page.

I turned the idea into a task https://www.notion.so/mui-org/Create-Community-page-71bac616e0774f13885d716a8fba2e00 so we can easily find it back in the future. cc @richbustos.

docs/data/material/getting-started/support/support.md

danilo-leal

Looking awesome overall! 🎉 Just left a consideration that's not a blocker for merging it!

docs/data/material/getting-started/support/support.md

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com> Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

richbustos · 2023-08-03T17:03:21Z

Non-blocker nit-pick:

The content looks great!

Just an issue on the design side of things. As a reader, I had a hard time understanding the hierarchy of title headings and grouping.

For example, as I was reading toward the end of "Social Media" I glanced at "Paid support" and was thinking it was still part of "Community help" because of the size of the heading.

No solution for now other than maybe increasing the size of headings.

danilo-leal · 2023-08-03T17:12:01Z

@richbustos I'll look into potential improvements to the heading sizes + weights! Thanks for pointing out 🤙

samuelsycamore · 2023-08-03T17:29:55Z

Good call, I agree that we could use a bigger difference between h2 and h3 styles 👍

Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>

richbustos

Looks good!

joserodolfofreitas

Looking great!
We could update https://mui.com/x/introduction/support/ as well.
What do you think, @richbustos?

samuelsycamore · 2023-08-07T18:40:24Z

Good call @joserodolfofreitas !

revisions

e66d6bf

samuelsycamore added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Jul 28, 2023

samuelsycamore requested review from joserodolfofreitas, oliviertassinari and danilo-leal July 28, 2023 19:44

oliviertassinari reviewed Jul 28, 2023

View reviewed changes

danilo-leal approved these changes Jul 31, 2023

View reviewed changes

danilo-leal reviewed Jul 31, 2023

View reviewed changes

docs/data/material/getting-started/support/support.md Show resolved Hide resolved

samuelsycamore and others added 3 commits July 31, 2023 19:57

Apply suggestions from code review

ec06590

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com> Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

discord, custom work, copyediting

f322b48

period inside link that's not ideal but better than nothing

8642553

samuelsycamore requested a review from oliviertassinari August 3, 2023 16:46

Slug LinkedIn

a0ce970

Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>

richbustos self-requested a review August 3, 2023 20:09

richbustos approved these changes Aug 3, 2023

View reviewed changes

joserodolfofreitas approved these changes Aug 7, 2023

View reviewed changes

samuelsycamore added 2 commits August 7, 2023 13:41

merge master

b3ad895

merge master again

cd19cb1

samuelsycamore merged commit 3231856 into mui:master Aug 9, 2023
18 checks passed

oliviertassinari mentioned this pull request Aug 11, 2023

[docs] Fix SEO issues reported by ahrefs #38423

Merged

samuelsycamore deleted the update-support-page branch April 3, 2024 17:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs][material] Revise the Support page #38207

[docs][material] Revise the Support page #38207

samuelsycamore commented Jul 28, 2023 •

edited

mui-bot commented Jul 28, 2023 •

edited

oliviertassinari left a comment •

edited

oliviertassinari Jul 28, 2023

richbustos Jul 28, 2023

oliviertassinari Aug 11, 2023

samuelsycamore Aug 11, 2023

richbustos Aug 11, 2023

oliviertassinari Aug 11, 2023 •

edited

oliviertassinari Aug 16, 2023 •

edited

danilo-leal left a comment

richbustos commented Aug 3, 2023 •

edited

danilo-leal commented Aug 3, 2023

samuelsycamore commented Aug 3, 2023

richbustos left a comment

joserodolfofreitas left a comment

samuelsycamore commented Aug 7, 2023

	Head here to see if your problem has already been resolved by the community, or else [post a question](https://stackoverflow.com/questions/tagged/mui) to get help from community experts as well as MUI maintainers.
	Head here to see if your problem has already been resolved by the community, or else [post a question](https://stackoverflow.com/questions/tagged/material-ui) to get help from community experts as well as MUI maintainers.

[docs][material] Revise the Support page #38207

[docs][material] Revise the Support page #38207

Conversation

samuelsycamore commented Jul 28, 2023 • edited

mui-bot commented Jul 28, 2023 • edited

Netlify deploy preview

Bundle size report

oliviertassinari left a comment • edited

Choose a reason for hiding this comment

oliviertassinari Jul 28, 2023

Choose a reason for hiding this comment

richbustos Jul 28, 2023

Choose a reason for hiding this comment

oliviertassinari Aug 11, 2023

Choose a reason for hiding this comment

samuelsycamore Aug 11, 2023

Choose a reason for hiding this comment

richbustos Aug 11, 2023

Choose a reason for hiding this comment

oliviertassinari Aug 11, 2023 • edited

Choose a reason for hiding this comment

oliviertassinari Aug 16, 2023 • edited

Choose a reason for hiding this comment

danilo-leal left a comment

Choose a reason for hiding this comment

richbustos commented Aug 3, 2023 • edited

danilo-leal commented Aug 3, 2023

samuelsycamore commented Aug 3, 2023

richbustos left a comment

Choose a reason for hiding this comment

joserodolfofreitas left a comment

Choose a reason for hiding this comment

samuelsycamore commented Aug 7, 2023

samuelsycamore commented Jul 28, 2023 •

edited

mui-bot commented Jul 28, 2023 •

edited

oliviertassinari left a comment •

edited

oliviertassinari Aug 11, 2023 •

edited

oliviertassinari Aug 16, 2023 •

edited

richbustos commented Aug 3, 2023 •

edited