diff --git a/docs/help-fastapi.md b/docs/help-fastapi.md new file mode 100644 index 000000000..914ed8b24 --- /dev/null +++ b/docs/help-fastapi.md @@ -0,0 +1,100 @@ +Are you liking **FastAPI**? + +Would you like to help FastAPI, other users, and the author? + +Or would you like to get help with **FastAPI**? + +There are very simple ways to help (several involve just one or two clicks). + +And there are several ways to get help too. + + +## Star **FastAPI** in GitHub + +You can "star" FastAPI in GitHub (clicking the star button at the top right): https://github.com/tiangolo/fastapi. + +By adding a star, other users will be able to find it more easily and see that it has been already useful for others. + + +## Watch the GitHub repository for releases + +You can "watch" FastAPI in GitHub (clicking the "watch" button at the top right): https://github.com/tiangolo/fastapi. + +There you can select "Releases only". + +Doing it, you will receive notifications (in your email) whenever there's a new release (a new version) of **FastAPI** with bug fixes and new features. + + +## Connect with the author + +You can connect with me (Sebastián Ramírez / `tiangolo`), the author. + +You can: + +* Follow me on **GitHub**. + * See other Open Source projects I have created that could help you. + * Follow me to see when I create a new Open Source project. +* Follow me on **Twitter**. + * Tell me how you use FastAPI (I love to hear that). + * Ask questions. +* Connect with me on **Linkedin**. + * Talk to me. + * Endorse me or recommend me :) +* Read what I write (or follow me) on **Medium**. + * Read other ideas, articles and tools I have created. + * Follow me to see when I publish something new. + + +## Tweet about **FastAPI** + +Tweet about **FastAPI** and let me and others why you like it. + +## Let me know how are you using **FastAPI** + +I love to hear about how **FastAPI** is being used, what have you liked in it, in which project/company are you using it, etc. + +You can let me know: + +* On **Twitter**. +* On **Linkedin**. +* On **Medium**. + +## Vote for FastAPI + +You can vote to include FastAPI in several "awesome lists": + +* Vote to include **FastAPI** in `awesome-python`. +* Vote to include **FastAPI** in `awesome-asyncio`. + +## Help others with issues in GitHub + +You can see existing issues and try and help others. + +## Watch the GitHub repository + +You can "watch" FastAPI in GitHub (clicking the "watch" button at the top right): https://github.com/tiangolo/fastapi. + +If you select "Watching" instead of "Releases only", you will receive notifications when someone creates a new issue. + +Then you can try and help them solving those issues. + +## Create issues + +You can create a new issue in the GitHub repository, for example to: + +* Report a bug/issue. +* Suggest a new feature. +* Ask a question. + +## Create a Pull Request + +You can create a Pull Request, for example: + +* To fix a typo you found on the documentation. +* To propose new documentation sections. +* To fix an existing issue/bug. +* To add a new feature. + +--- + +Thanks! diff --git a/docs/release-notes.md b/docs/release-notes.md index 07ede5b57..a5c5670bc 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,5 +1,7 @@ ## Next +* Add section about helping and getting help with **FastAPI**. + ## 0.5.0 * Add new `HTTPException` with support for custom headers. With new documentation for handling errors at: https://fastapi.tiangolo.com/tutorial/handling-errors/. PR #35. diff --git a/mkdocs.yml b/mkdocs.yml index 74d3a827a..1cfbc02d3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ nav: - Project Generation - Template: 'project-generation.md' - Alternatives, Inspiration and Comparisons: 'alternatives.md' - Benchmarks: 'benchmarks.md' + - Help FastAPI - Get Help: 'help-fastapi.md' - Release Notes: release-notes.md markdown_extensions: