-
Notifications
You must be signed in to change notification settings - Fork 320
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make the docs more user friendly #950
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.. _asyncio-index: | ||
|
||
Asyncio in Eventlet | ||
################### | ||
|
||
Asyncio Compatibility | ||
===================== | ||
|
||
Compatibility between Asyncio and Eventlet has been recently introduced. | ||
|
||
You may be interested by the state of the art of this compatibility and by | ||
the potential limitations, so please take a look at | ||
:ref:`asyncio-compatibility`. | ||
|
||
Asyncio Hub & Functions | ||
======================= | ||
|
||
Discover the :mod:`Asyncio Hub <eventlet.hubs.asyncio>` | ||
|
||
You may also want to take a look to the | ||
:mod:`Asyncio compatibility functions <eventlet.asyncio>`. | ||
|
||
Migrating from Eventlet to Asyncio | ||
================================== | ||
|
||
Want to use Asyncio and Eventlet together or you simply want to migrate | ||
off of Eventlet? | ||
|
||
Follow the :ref:`official migration guide <migration-guide>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.. warning:: | ||
|
||
Eventlet is now in maintenance mode, so only the changes who are related | ||
to fixing a bug or who are related to the new Asyncio hub will be accepted. | ||
New features outside of the scope of the Asyncio hub won't be accepted. | ||
|
||
:ref:`migration-guide` is strongly encouraged. We encourage existing | ||
users to migrate to Asyncio. For further details see the official | ||
:ref:`migration guide <migration-guide>`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _authors: | ||
|
||
Authors | ||
======= | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
.. _how-to-contribute: | ||
|
||
How to Contribute to Eventlet | ||
############################# | ||
|
||
.. include:: asyncio/warning.rst | ||
|
||
Contribution are welcome. | ||
|
||
You want to report something? Read :ref:`report-a-bug`. | ||
|
||
You want to propose changes? Read :ref:`propose-changes`. | ||
|
||
.. _report-a-bug: | ||
|
||
Report a Bug | ||
============= | ||
|
||
You find a bug and you want to report it? | ||
|
||
You simply have to `create a new github issue <https://github.com/eventlet/eventlet/issues>`_ | ||
where you describe your problem. | ||
|
||
Do not forget to provide technical details like: | ||
|
||
* the hub you use | ||
* the context of your bug | ||
* the error message you get | ||
* everything else that may help us to understand your problem. | ||
|
||
The more you give details, the more we will be able to help you. | ||
|
||
.. _propose-changes: | ||
|
||
Propose Changes | ||
=============== | ||
|
||
You may want to propose changes to fix a bug, improve the documentation, etc. | ||
|
||
Feel free to open a pull request: https://github.com/eventlet/eventlet/pulls | ||
|
||
.. include:: asyncio/warning.rst | ||
|
||
We will be happy to review it. | ||
|
||
At this point you may be also interested by :ref:`how to test Eventlet <testing-eventlet>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _history: | ||
|
||
History | ||
------- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO it is better to move this file in the doc source and at the rst format.