From ac99792762a82dd5f2eb72c0657cd5bbf5023068 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Sat, 7 Nov 2020 21:48:25 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20Discord=20chat=20(#2322)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marcelo Trylesinski --- README.md | 3 --- docs/en/docs/help-fastapi.md | 38 +++++++++++++++++++++++------------- docs/en/docs/index.md | 3 --- docs/en/mkdocs.yml | 2 -- docs/es/docs/index.md | 3 --- docs/es/mkdocs.yml | 2 -- docs/fr/docs/index.md | 3 --- docs/fr/mkdocs.yml | 2 -- docs/it/docs/index.md | 3 --- docs/it/mkdocs.yml | 2 -- docs/ja/docs/help-fastapi.md | 4 ---- docs/ja/docs/index.md | 3 --- docs/ja/mkdocs.yml | 2 -- docs/ko/docs/index.md | 3 --- docs/ko/mkdocs.yml | 2 -- docs/pt/docs/index.md | 3 --- docs/pt/mkdocs.yml | 2 -- docs/ru/docs/index.md | 3 --- docs/ru/mkdocs.yml | 2 -- docs/tr/docs/index.md | 3 --- docs/tr/mkdocs.yml | 2 -- docs/uk/docs/index.md | 3 --- docs/uk/mkdocs.yml | 2 -- docs/zh/docs/help-fastapi.md | 4 ---- docs/zh/docs/index.md | 3 --- docs/zh/mkdocs.yml | 2 -- 26 files changed, 24 insertions(+), 80 deletions(-) diff --git a/README.md b/README.md index 2988203bb..955493813 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/en/docs/help-fastapi.md b/docs/en/docs/help-fastapi.md index aed3ed6f6..b4b22cf1b 100644 --- a/docs/en/docs/help-fastapi.md +++ b/docs/en/docs/help-fastapi.md @@ -52,12 +52,13 @@ I love to hear about how **FastAPI** is being used, what have you liked in it, i * Vote for **FastAPI** in Slant. * Vote for **FastAPI** in AlternativeTo. -* Vote for **FastAPI** on awesome-rest. ## Help others with issues in GitHub You can see existing issues and try and help others, most of the times they are questions that you might already know the answer for. 🤓 +If you are helping a lot of people on issues you might become an official [FastAPI Expert](fastapi-people.md#experts){.internal-link target=_blank}. 🎉 + ## Watch the GitHub repository You can "watch" FastAPI in GitHub (clicking the "watch" button at the top right): https://github.com/tiangolo/fastapi. 👀 @@ -70,43 +71,52 @@ Then you can try and help them solving those issues. You can create a new issue in the GitHub repository, for example to: -* Ask a question or ask about a problem. -* Suggest a new feature. +* Ask a **question** or ask about a **problem**. +* Suggest a new **feature**. **Note**: if you create an issue then I'm going to ask you to also help others. 😉 ## Create a Pull Request -You can create a Pull Request, for example: +You can [contribute](contributing.md){.internal-link target=_blank} to the source code with Pull Requests, for example: * To fix a typo you found on the documentation. +* To share an article, video, or podcast you created or found about FastAPI by editing this file. + * Make sure you add your link to the end of the corresponding section. +* To help [translate the documentation](contributing.md#translations){.internal-link target=_blank} to your language. + * You can also help reviewing the translations created by others. * To propose new documentation sections. * To fix an existing issue/bug. * To add a new feature. ## Join the chat - - Join the chat at https://gitter.im/tiangolo/fastapi - +Join the 👥 Discord chat server 👥 and hang out with others in the FastAPI community. + +!!! tip + For questions, ask them in GitHub issues, there's a much better chance you will receive help by the [FastAPI Experts](fastapi-people.md#experts){.internal-link target=_blank}. -Join the chat on Gitter: https://gitter.im/tiangolo/fastapi. + Use the chat only for other general conversations. -There you can have quick conversations with others, help others, share ideas, etc. +There is also the previous Gitter chat, but as it doesn't have channels and advanced features, conversations are more difficult, so Discord is now the recommended system. -But have in mind that as it allows more "free conversation", it's easy to ask questions that are too general and more difficult to answer, so, you might not receive answers. +### Don't use the chat for questions -In GitHub issues the template will guide to to write the right question so that you can more easily get a good answer, or even solve the problem yourself even before asking. And in GitHub I can make sure I always answer everything, even if it takes some time. I can't personally do that with the Gitter chat. 😅 +Have in mind that as chats allow more "free conversation", it's easy to ask questions that are too general and more difficult to answer, so, you might not receive answers. -Conversations in Gitter are also not as easily searchable as in GitHub, so questions and answers might get lost in the conversation. +In GitHub issues the template will guide you to write the right question so that you can more easily get a good answer, or even solve the problem yourself even before asking. And in GitHub I can make sure I always answer everything, even if it takes some time. I can't personally do that with the chat systems. 😅 -On the other side, there's more than 1000 people in the chat, so there's a high chance you'll find someone to talk to there, almost all the time. 😄 +Conversations in the chat systems are also not as easily searchable as in GitHub, so questions and answers might get lost in the conversation. And only the ones in GitHub issues count to become a [FastAPI Expert](fastapi-people.md#experts){.internal-link target=_blank}, so you will most probably receive more attention in GitHub isssues. + +On the other side, there are thousands of users in the chat systems, so there's a high chance you'll find someone to talk to there, almost all the time. 😄 ## Sponsor the author You can also financially support the author (me) through GitHub sponsors. -There you could buy me a coffee ☕️ to say thanks 😄. +There you could buy me a coffee ☕️ to say thanks. 😄 + +And you can also become a Silver or Gold sponsor for FastAPI. 🏅🎉 ## Sponsor the tools that power FastAPI diff --git a/docs/en/docs/index.md b/docs/en/docs/index.md index c52f716a9..518beb33c 100644 --- a/docs/en/docs/index.md +++ b/docs/en/docs/index.md @@ -14,9 +14,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml index abd0d54bb..c3d8ea2b6 100644 --- a/docs/en/mkdocs.yml +++ b/docs/en/mkdocs.yml @@ -175,5 +175,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - js/termynal.js - js/custom.js -- js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/es/docs/index.md b/docs/es/docs/index.md index 8cd73778a..5beb61670 100644 --- a/docs/es/docs/index.md +++ b/docs/es/docs/index.md @@ -14,9 +14,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/es/mkdocs.yml b/docs/es/mkdocs.yml index 6a038af16..0f02540b6 100644 --- a/docs/es/mkdocs.yml +++ b/docs/es/mkdocs.yml @@ -80,5 +80,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/fr/docs/index.md b/docs/fr/docs/index.md index 681cc64ba..f913a1f68 100644 --- a/docs/fr/docs/index.md +++ b/docs/fr/docs/index.md @@ -18,9 +18,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml index 120eabfad..e76c1b9ce 100644 --- a/docs/fr/mkdocs.yml +++ b/docs/fr/mkdocs.yml @@ -73,5 +73,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/it/docs/index.md b/docs/it/docs/index.md index 3fb64bf7d..45a02d489 100644 --- a/docs/it/docs/index.md +++ b/docs/it/docs/index.md @@ -18,9 +18,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/it/mkdocs.yml b/docs/it/mkdocs.yml index eb60ce968..5b040ec80 100644 --- a/docs/it/mkdocs.yml +++ b/docs/it/mkdocs.yml @@ -73,5 +73,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/ja/docs/help-fastapi.md b/docs/ja/docs/help-fastapi.md index 7a48891e8..166acb586 100644 --- a/docs/ja/docs/help-fastapi.md +++ b/docs/ja/docs/help-fastapi.md @@ -84,10 +84,6 @@ GitHubレポジトリで - Join the chat at https://gitter.im/tiangolo/fastapi - - Gitterでチャットに参加: https://gitter.im/tiangolo/fastapi. そこで、他の人と手早く会話したり、手助けやアイデアの共有などができます。 diff --git a/docs/ja/docs/index.md b/docs/ja/docs/index.md index 3598b1594..f492906cb 100644 --- a/docs/ja/docs/index.md +++ b/docs/ja/docs/index.md @@ -14,9 +14,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml index 6b5b78630..aa06ed5c9 100644 --- a/docs/ja/mkdocs.yml +++ b/docs/ja/mkdocs.yml @@ -93,5 +93,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/ko/docs/index.md b/docs/ko/docs/index.md index 3f03a337f..8f5ff6687 100644 --- a/docs/ko/docs/index.md +++ b/docs/ko/docs/index.md @@ -18,9 +18,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/ko/mkdocs.yml b/docs/ko/mkdocs.yml index 2dfedb9b8..ca3d49a7a 100644 --- a/docs/ko/mkdocs.yml +++ b/docs/ko/mkdocs.yml @@ -73,5 +73,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/pt/docs/index.md b/docs/pt/docs/index.md index 359346064..fd6428e15 100644 --- a/docs/pt/docs/index.md +++ b/docs/pt/docs/index.md @@ -14,9 +14,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/pt/mkdocs.yml b/docs/pt/mkdocs.yml index 7557b3879..59aeee1d5 100644 --- a/docs/pt/mkdocs.yml +++ b/docs/pt/mkdocs.yml @@ -81,5 +81,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/ru/docs/index.md b/docs/ru/docs/index.md index dd8198557..3ae908357 100644 --- a/docs/ru/docs/index.md +++ b/docs/ru/docs/index.md @@ -18,9 +18,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml index 1a5c8f0d4..49d91c250 100644 --- a/docs/ru/mkdocs.yml +++ b/docs/ru/mkdocs.yml @@ -73,5 +73,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/tr/docs/index.md b/docs/tr/docs/index.md index 6a616e790..97964b70c 100644 --- a/docs/tr/docs/index.md +++ b/docs/tr/docs/index.md @@ -18,9 +18,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/tr/mkdocs.yml b/docs/tr/mkdocs.yml index 00490564c..8cca6d6d1 100644 --- a/docs/tr/mkdocs.yml +++ b/docs/tr/mkdocs.yml @@ -73,5 +73,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/uk/docs/index.md b/docs/uk/docs/index.md index 7bb83b766..4cf339117 100644 --- a/docs/uk/docs/index.md +++ b/docs/uk/docs/index.md @@ -18,9 +18,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/uk/mkdocs.yml b/docs/uk/mkdocs.yml index 38f919ec2..4d320587a 100644 --- a/docs/uk/mkdocs.yml +++ b/docs/uk/mkdocs.yml @@ -73,5 +73,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js diff --git a/docs/zh/docs/help-fastapi.md b/docs/zh/docs/help-fastapi.md index 57b20c4fc..99e37b7c1 100644 --- a/docs/zh/docs/help-fastapi.md +++ b/docs/zh/docs/help-fastapi.md @@ -26,10 +26,6 @@ ## 加入聊天室 - - Join the chat at https://gitter.im/tiangolo/fastapi - - 加入 Gitter 上的聊天室：https://gitter.im/tiangolo/fastapi。 在这里你可以快速提问、帮助他人、分享想法等。 diff --git a/docs/zh/docs/index.md b/docs/zh/docs/index.md index 2098e9e1b..2502295a7 100644 --- a/docs/zh/docs/index.md +++ b/docs/zh/docs/index.md @@ -14,9 +14,6 @@ Package version - - Join the chat at https://gitter.im/tiangolo/fastapi -

--- diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml index e595e8c0b..fa4b13d29 100644 --- a/docs/zh/mkdocs.yml +++ b/docs/zh/mkdocs.yml @@ -88,5 +88,3 @@ extra_javascript: - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js - https://fastapi.tiangolo.com/js/termynal.js - https://fastapi.tiangolo.com/js/custom.js -- https://fastapi.tiangolo.com/js/chat.js -- https://sidecar.gitter.im/dist/sidecar.v1.js