Updated Docs

* Moved svg files of benchmark for next benchmark
This commit is contained in:
Andrew-Chen-Wang 2020-02-13 21:15:38 -05:00
parent 8c35a6f931
commit a611950f00
17 changed files with 33 additions and 31 deletions

View file

@ -29,9 +29,9 @@ Quickstart
Cachalot officially supports Python 2.7, 3.4-3.8 and Django 1.11, 2.0-2.2, 3.0 with the databases PostgreSQL, SQLite, and MySQL.
Note 1: Python 3.4 with MySQL fails on tests. If you're MySQL is configured correctly, then it may work.
Note 1: Python 3.4 with MySQL fails on tests. If your MySQL is configured correctly, then it may work.
Note 2: Python 3.5 with Django 1.11 in tests prove to have a performance issue.
Note 2: Python 3.5 with Django 1.11 in tests prove to occasionally have performance issues.
Third-Party Cache Comparison
----------------------------

View file

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View file

@ -21,7 +21,7 @@ But what you may not know is that
Conditions
..........
.. include:: ../benchmark/conditions.rst
.. include:: ../benchmark/docs/2018-08-09/conditions.rst
Note that
`MySQLs query cache <http://dev.mysql.com/doc/refman/5.7/en/query-cache.html>`_
@ -30,17 +30,17 @@ is active during the benchmark.
Database results
................
.. include:: ../benchmark/db_results.rst
.. include:: ../benchmark/docs/2018-08-09/db_results.rst
.. image:: ../benchmark/db.svg
.. image:: ../benchmark/docs/2018-08-09/db.svg
Cache results
.............
.. include:: ../benchmark/cache_results.rst
.. include:: ../benchmark/docs/2018-08-09/cache_results.rst
.. image:: ../benchmark/cache.svg
.. image:: ../benchmark/docs/2018-08-09/cache.svg
Database detailed results
@ -49,17 +49,17 @@ Database detailed results
MySQL
~~~~~
.. image:: ../benchmark/db_mysql.svg
.. image:: ../benchmark/docs/2018-08-09/db_mysql.svg
PostgreSQL
~~~~~~~~~~
.. image:: ../benchmark/db_postgresql.svg
.. image:: ../benchmark/docs/2018-08-09/db_postgresql.svg
SQLite
~~~~~~
.. image:: ../benchmark/db_sqlite.svg
.. image:: ../benchmark/docs/2018-08-09/db_sqlite.svg
Cache detailed results
@ -68,27 +68,27 @@ Cache detailed results
File-based
~~~~~~~~~~
.. image:: ../benchmark/cache_filebased.svg
.. image:: ../benchmark/docs/2018-08-09/cache_filebased.svg
Locmem
~~~~~~
.. image:: ../benchmark/cache_locmem.svg
.. image:: ../benchmark/docs/2018-08-09/cache_locmem.svg
Memcached (python-memcached)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../benchmark/cache_memcached.svg
.. image:: ../benchmark/docs/2018-08-09/cache_memcached.svg
Memcached (pylibmc)
~~~~~~~~~~~~~~~~~~~
.. image:: ../benchmark/cache_pylibmc.svg
.. image:: ../benchmark/docs/2018-08-09/cache_pylibmc.svg
Redis
~~~~~
.. image:: ../benchmark/cache_redis.svg
.. image:: ../benchmark/docs/2018-08-09/cache_redis.svg

View file

@ -44,6 +44,22 @@ Note: In settings, you can use `CACHALOT_UNCACHABLE_TABLES <https://django-cacha
Why use cachalot? `Check out our comparison <https://django-cachalot.readthedocs.io/en/latest/introduction.html#comparison-with-similar-tools>`_
Below the tree is an in-depth opinion from the new maintainer:
.. toctree::
:maxdepth: 2
introduction
quickstart
limits
api
benchmark
todo
reporting
how
legacy
changelog
In-depth opinion (from new maintainer):
There are three main third party caches: cachalot, cache-machine, and cache-ops. Which do you use? We suggest a mix:
@ -71,17 +87,3 @@ caching and invalidating an entire table. It's like trying to boil 1 ton of nood
boiling 1 ton of noodles. Which is more efficient? The splitting up of them.
Note 1: My personal experience with caches stems from Reddit's: https://redditblog.com/2017/01/17/caching-at-reddit/
.. toctree::
:maxdepth: 2
introduction
quickstart
limits
api
benchmark
todo
reporting
how
legacy
changelog

View file

@ -7,7 +7,7 @@ Bug reports, questions, discussion, new features
`on GitHub <https://github.com/noripyt/django-cachalot/issues>`_
- If you have **a question** on how django-cachalot works
or to **simply discuss**,
`chat with us on gitter <https://gitter.im/django-cachalot/Lobby>`_.
`chat with us on Slack <https://join.slack.com/t/cachalotdjango/shared_invite/enQtOTMyNzI0NTQzOTA3LWViYmYwMWY3MmU0OTZkYmNiMjBhN2NjNjc4OWVlZDNiMjMxN2Y3YzljYmNiYTY4ZTRjOGQxZDRiMTM0NWE3NGI>`_.
- If you want **to add a feature**:
- if you have an idea on how to implement it, you can fork the project
@ -15,4 +15,4 @@ Bug reports, questions, discussion, new features
someone else could already be working on it
- if youre sure that its a must-have feature, open an issue
- if its just a vague idea, please
`ask on gitter <https://gitter.im/django-cachalot/Lobby>`_ first
`ask on Slack <https://join.slack.com/t/cachalotdjango/shared_invite/enQtOTMyNzI0NTQzOTA3LWViYmYwMWY3MmU0OTZkYmNiMjBhN2NjNjc4OWVlZDNiMjMxN2Y3YzljYmNiYTY4ZTRjOGQxZDRiMTM0NWE3NGI>`_ first