From 353b57513e9fb69b131795d1f587b7939a7f7ae5 Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Mon, 28 Dec 2020 14:42:31 -0500 Subject: [PATCH] Add discussion forum info --- .github/ISSUE_TEMPLATE/config.yml | 6 ++-- CONTRIBUTING.md | 2 +- docs/getting-started/community.md | 43 +++++++++++------------- docs/tutorials/integrating-with-rails.md | 2 +- 4 files changed, 24 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 9b6b628b..76620f53 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ contact_links: - - name: Personal Support - url: https://github.com/sponsors/claviska - about: Support for issues outside the scope of the library can be obtained via sponsorship. + - name: Help & Support + url: https://github.com/shoelace-style/shoelace/discussions/categories/help + about: Please don't create issues for personal help requests. Instead, ask your question on the discussion forum. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63179d08..c20a2517 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Please take a moment to review these guidelines to make the contribution process The [issue tracker](https://github.com/shoelace-style/shoelace/issues) is for bug reports, feature requests, and pull requests. -- Please **do not** use the issue tracker for personal support requests. Please [join the community chat](https://discord.gg/mg8f26C) or [ask your question](https://stackoverflow.com/questions/ask?tags=shoelace) on StackOverflow instead. +- Please **do not** use the issue tracker for personal support requests. Use [the discussion forum](https://github.com/shoelace-style/shoelace/discussions/categories/help) instead. - Please **do not** derail, hijack, or troll issues. Keep the discussion on topic and be respectful of others. - Please **do not** post comments with "+1" or "👍". Use [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) instead. - Please **do** use the issue tracker for feature requests, bug reports, and pull requests. diff --git a/docs/getting-started/community.md b/docs/getting-started/community.md index ae4d0798..ccbd6993 100644 --- a/docs/getting-started/community.md +++ b/docs/getting-started/community.md @@ -2,45 +2,40 @@ Shoelace has a budding community of designers and developers that are building amazing things with web components. We'd love for you to become a part of it! -## Discord +Please be respectful of other users and remember that Shoelace is an open source project. We'll try to help when we can, but there's no guarantee we'll be able solve your problem. Please manage your expectations and don't forget to contribute back to the conversation when you can! -The [community chat](https://discord.gg/mg8f26C) is open to the public and powered by [Discord](https://discord.com/). This is the best place to: +## Discussion Forum -- Ask questions -- Get feedback +The [discussion forum](https://github.com/shoelace-style/shoelace/discussions) is open to anyone with a GitHub account. This is the best place to: + +- Ask for help +- Share ideas and get feedback - Show the community what you're working on - Hang out with other designers, developers, and Shoelace users -- Talk to the creator -Please be respectful of other users and remember that Shoelace is an open source project. We'll try to help when we can, but there's no guarantee we'll be able solve your problem. Please manage your expectations and don't forget to contribute back to the conversation when you can! + + Join the Discussion + + +## Community Chat + +The [community chat](https://discord.gg/mg8f26C) is open to the public and powered by [Discord](https://discord.com/). This is a good place to: + +- Ask for help +- Share ideas and get feedback +- Show the community what you're working on +- Hang out with other designers, developers, and Shoelace users Join the Chat - -## Stack Overflow - -If you have a specific problem to solve, Stack Overflow is a great place to get feedback from other developers. For best results, try to generalize your question and avoid bloating it with unnecessary or unrelated code. - - - Ask a Question - - - ## Twitter Follow [@shoelace_style](https://twitter.com/shoelace_style) on Twitter for general updates and announcements about Shoelace. This is a great place to say "hi" or to share something you're working on. You're also welcome to follow [@claviska](https://twitter.com/claviska), the creator, for tweets about web components, web development, and life. -**Please avoid using Twitter for support questions.** The community chat is a much better place to share code snippets, screenshots, and other troubleshooting info. You'll have much better luck there, as more users will have a chance to help you. - -Oh, and don't forget to tell your followers about Shoelace! +**Please avoid using Twitter for support questions.** The [discussion forum](https://github.com/shoelace-style/shoelace/discussions) is a much better place to share code snippets, screenshots, and other troubleshooting info. You'll have much better luck there, as more users will have a chance to help you. Follow on Twitter - - - Send a Tweet - - diff --git a/docs/tutorials/integrating-with-rails.md b/docs/tutorials/integrating-with-rails.md index 87f069e8..79c620bb 100644 --- a/docs/tutorials/integrating-with-rails.md +++ b/docs/tutorials/integrating-with-rails.md @@ -1,6 +1,6 @@ # Integrating with Rails -This page explains how to integrate Shoelace with a Rails app. This is a community-maintained document. For questions about this integration, please [ask the community](https://discord.gg/mg8f26C). +This page explains how to integrate Shoelace with a Rails app. This is a community-maintained document. For questions about this integration, please [ask the community](/getting-started/community). ## Requirements