From 340100ee997756e5b84a2b3f7615b1682e07bbb5 Mon Sep 17 00:00:00 2001 From: Elrond Date: Sun, 10 Mar 2013 22:33:28 +0100 Subject: [PATCH] Start a storage section. With the workbench stuff in it. --- docs/source/devel/storage.rst | 43 +++++++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + 2 files changed, 44 insertions(+) create mode 100644 docs/source/devel/storage.rst diff --git a/docs/source/devel/storage.rst b/docs/source/devel/storage.rst new file mode 100644 index 00000000..52406c4e --- /dev/null +++ b/docs/source/devel/storage.rst @@ -0,0 +1,43 @@ +========= + Storage +========= + + +See for now: http://wiki.mediagoblin.org/Storage + +Things get moved here. + + +The storage systems attached to your app +---------------------------------------- + +Dynamic content: queue_store and public_store +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The workbench +~~~~~~~~~~~~~ + +In addition, there's a "workbench" used during +processing... it's just for temporary files during +processing, and also for making local copies of stuff that +might be on remote storage interfaces while transitionally +moving/converting from the queue_store to the public store. +See the workbench module documentation for more. + +.. automodule:: mediagoblin.tools.workbench + :members: + :show-inheritance: + + +Static assets / staticdirect +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +StorageInterface and implementations +------------------------------------ + +The guts of StorageInterface and friends +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Writing code to store stuff +~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/index.rst b/docs/source/index.rst index 0ddacb71..7f692d57 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -84,6 +84,7 @@ This chapter contains various information for developers. :maxdepth: 1 devel/codebase + devel/storage devel/originaldesigndecisions -- 2.25.1