From 48922d58efb932f6d5a48ef4ae2622adbc06d871 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Thu, 2 Feb 2012 10:44:00 -0400 Subject: [PATCH] Documentation update for the document indexing --- docs/releases/0.12.rst | 23 +++++++++++++++++++++-- docs/topics/settings.rst | 20 +++++++------------- 2 files changed, 28 insertions(+), 15 deletions(-) diff --git a/docs/releases/0.12.rst b/docs/releases/0.12.rst index dd198d13ed..748520b87c 100644 --- a/docs/releases/0.12.rst +++ b/docs/releases/0.12.rst @@ -122,6 +122,19 @@ column after those is ignored. * The ``--skip-repeated`` tells the importedr to not stop when finding that a user already exists in the database. +Refactored document indexing +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The document indexing functionality has been improved and moved from experimental +stage to beta stage. Index configuration menus are now available on the +``Setup`` menu and allows administrators to create a skeleton tree that will +be populated with document links depending on their metadata and properties. +This populated tree can also be mirrored on the physical filesystem and shared +using Samba or another filesharing server giving users a structured view +of the documents contained within **Mayan EDMS** from the ``Indexes`` tab +or from a mirrored index shared via the network. A new configuration option +has been added, :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`, which maps +the index internal name with the physical directory where such index will be +mirrored on disk. Upgrading from a previous version ================================= @@ -191,15 +204,21 @@ so write down your role permission setup before upgrading. Bugs fixed ========== * Issue #17, special thanks to Dave Herring for all the help including - access to a machine suffering with the issue. + access to a machine suffering with the issue, and to Сергей Глита for + his research and eventual find of the core cause. * Statistics fixes. * Fixed get_image_cache_name regression in the OCR app. Stuff removed ============= -* Removal of the OCR_CACHE_URI configuration option. * Support for Celery and Sentry has been drop for now. * Removed the 'db_index' argument from Text fields definition and migrations as it was causing error messages for MySQL users, thanks to Сергей Глита for reporting this one. +* Configuration options removed: + + * OCR_CACHE_URI + * DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_PATH - Use the newest :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING` + * DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE - Use the newest :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING` + diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 9989752a7d..d01de8049d 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -297,21 +297,15 @@ DOCUMENT_INDEXING_FILESYSTEM_MAX_SUFFIX_COUNT Default: ``1000`` -.. setting:: DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_PATH +.. setting:: DOCUMENT_INDEXING_FILESYSTEM_SERVING -DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_PATH ---------------------------------------------- - -Default: ``/tmp/mayan/documents`` - - -.. setting:: DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE +DOCUMENT_INDEXING_FILESYSTEM_SERVING +------------------------------------ + +Default: ``{}`` + +A dictionary that maps the index name and where on the filesystem that index will be mirrored. -DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE ------------------------------------------------ - -Default: ``True`` - OCR ===