From a611950f00a9b8cd6ca7aa1f73a2395e63e3e83d Mon Sep 17 00:00:00 2001 From: Andrew-Chen-Wang Date: Thu, 13 Feb 2020 21:15:38 -0500 Subject: [PATCH] Updated Docs * Moved svg files of benchmark for next benchmark --- README.rst | 4 +-- benchmark/{ => docs/2018-08-09}/cache.svg | 0 .../{ => docs/2018-08-09}/cache_filebased.svg | 0 .../{ => docs/2018-08-09}/cache_locmem.svg | 0 .../{ => docs/2018-08-09}/cache_memcached.svg | 0 .../{ => docs/2018-08-09}/cache_pylibmc.svg | 0 .../{ => docs/2018-08-09}/cache_redis.svg | 0 .../{ => docs/2018-08-09}/cache_results.rst | 0 .../{ => docs/2018-08-09}/conditions.rst | 0 benchmark/{ => docs/2018-08-09}/db.svg | 0 benchmark/{ => docs/2018-08-09}/db_mysql.svg | 0 .../{ => docs/2018-08-09}/db_postgresql.svg | 0 .../{ => docs/2018-08-09}/db_results.rst | 0 benchmark/{ => docs/2018-08-09}/db_sqlite.svg | 0 docs/benchmark.rst | 26 ++++++++-------- docs/index.rst | 30 ++++++++++--------- docs/reporting.rst | 4 +-- 17 files changed, 33 insertions(+), 31 deletions(-) rename benchmark/{ => docs/2018-08-09}/cache.svg (100%) rename benchmark/{ => docs/2018-08-09}/cache_filebased.svg (100%) rename benchmark/{ => docs/2018-08-09}/cache_locmem.svg (100%) rename benchmark/{ => docs/2018-08-09}/cache_memcached.svg (100%) rename benchmark/{ => docs/2018-08-09}/cache_pylibmc.svg (100%) rename benchmark/{ => docs/2018-08-09}/cache_redis.svg (100%) rename benchmark/{ => docs/2018-08-09}/cache_results.rst (100%) rename benchmark/{ => docs/2018-08-09}/conditions.rst (100%) rename benchmark/{ => docs/2018-08-09}/db.svg (100%) rename benchmark/{ => docs/2018-08-09}/db_mysql.svg (100%) rename benchmark/{ => docs/2018-08-09}/db_postgresql.svg (100%) rename benchmark/{ => docs/2018-08-09}/db_results.rst (100%) rename benchmark/{ => docs/2018-08-09}/db_sqlite.svg (100%) diff --git a/README.rst b/README.rst index 5f2e6d0..3ec9666 100644 --- a/README.rst +++ b/README.rst @@ -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 ---------------------------- diff --git a/benchmark/cache.svg b/benchmark/docs/2018-08-09/cache.svg similarity index 100% rename from benchmark/cache.svg rename to benchmark/docs/2018-08-09/cache.svg diff --git a/benchmark/cache_filebased.svg b/benchmark/docs/2018-08-09/cache_filebased.svg similarity index 100% rename from benchmark/cache_filebased.svg rename to benchmark/docs/2018-08-09/cache_filebased.svg diff --git a/benchmark/cache_locmem.svg b/benchmark/docs/2018-08-09/cache_locmem.svg similarity index 100% rename from benchmark/cache_locmem.svg rename to benchmark/docs/2018-08-09/cache_locmem.svg diff --git a/benchmark/cache_memcached.svg b/benchmark/docs/2018-08-09/cache_memcached.svg similarity index 100% rename from benchmark/cache_memcached.svg rename to benchmark/docs/2018-08-09/cache_memcached.svg diff --git a/benchmark/cache_pylibmc.svg b/benchmark/docs/2018-08-09/cache_pylibmc.svg similarity index 100% rename from benchmark/cache_pylibmc.svg rename to benchmark/docs/2018-08-09/cache_pylibmc.svg diff --git a/benchmark/cache_redis.svg b/benchmark/docs/2018-08-09/cache_redis.svg similarity index 100% rename from benchmark/cache_redis.svg rename to benchmark/docs/2018-08-09/cache_redis.svg diff --git a/benchmark/cache_results.rst b/benchmark/docs/2018-08-09/cache_results.rst similarity index 100% rename from benchmark/cache_results.rst rename to benchmark/docs/2018-08-09/cache_results.rst diff --git a/benchmark/conditions.rst b/benchmark/docs/2018-08-09/conditions.rst similarity index 100% rename from benchmark/conditions.rst rename to benchmark/docs/2018-08-09/conditions.rst diff --git a/benchmark/db.svg b/benchmark/docs/2018-08-09/db.svg similarity index 100% rename from benchmark/db.svg rename to benchmark/docs/2018-08-09/db.svg diff --git a/benchmark/db_mysql.svg b/benchmark/docs/2018-08-09/db_mysql.svg similarity index 100% rename from benchmark/db_mysql.svg rename to benchmark/docs/2018-08-09/db_mysql.svg diff --git a/benchmark/db_postgresql.svg b/benchmark/docs/2018-08-09/db_postgresql.svg similarity index 100% rename from benchmark/db_postgresql.svg rename to benchmark/docs/2018-08-09/db_postgresql.svg diff --git a/benchmark/db_results.rst b/benchmark/docs/2018-08-09/db_results.rst similarity index 100% rename from benchmark/db_results.rst rename to benchmark/docs/2018-08-09/db_results.rst diff --git a/benchmark/db_sqlite.svg b/benchmark/docs/2018-08-09/db_sqlite.svg similarity index 100% rename from benchmark/db_sqlite.svg rename to benchmark/docs/2018-08-09/db_sqlite.svg diff --git a/docs/benchmark.rst b/docs/benchmark.rst index ac0597b..a679587 100644 --- a/docs/benchmark.rst +++ b/docs/benchmark.rst @@ -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 `MySQL’s query cache `_ @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 233df62..87ccaec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,6 +44,22 @@ Note: In settings, you can use `CACHALOT_UNCACHABLE_TABLES `_ +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 diff --git a/docs/reporting.rst b/docs/reporting.rst index 7ed53ee..4ea16e5 100644 --- a/docs/reporting.rst +++ b/docs/reporting.rst @@ -7,7 +7,7 @@ Bug reports, questions, discussion, new features `on GitHub `_ - If you have **a question** on how django-cachalot works or to **simply discuss**, - `chat with us on gitter `_. + `chat with us on Slack `_. - 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 you’re sure that it’s a must-have feature, open an issue - if it’s just a vague idea, please - `ask on gitter `_ first + `ask on Slack `_ first