From 56b597762d2103a89cc4651cc47cec86a655c555 Mon Sep 17 00:00:00 2001 From: Janette Day Date: Thu, 4 Jan 2024 18:05:39 -0600 Subject: [PATCH] Add documentation --- docs/source/developer-guide/dev_search.rst | 5 +++++ modules/metastore/modules/metastore_facets/README.md | 9 +++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/source/developer-guide/dev_search.rst b/docs/source/developer-guide/dev_search.rst index 249dc3fdfe..c77914b7ee 100644 --- a/docs/source/developer-guide/dev_search.rst +++ b/docs/source/developer-guide/dev_search.rst @@ -1,2 +1,7 @@ DKAN Search =========== + +If you plan to build your data site with a Drupal theme rather than a decoupled frontend the metastore_search module provides a dataset search view that you can use as a starting point. + +.. include:: ../../../modules/metastore/modules/metastore_facets/README.md + :parser: myst_parser.docutils_ diff --git a/modules/metastore/modules/metastore_facets/README.md b/modules/metastore/modules/metastore_facets/README.md index 8e85b420d1..4ee9e8349e 100644 --- a/modules/metastore/modules/metastore_facets/README.md +++ b/modules/metastore/modules/metastore_facets/README.md @@ -1,6 +1,6 @@ # Metastore Facets -This is an optional module for sites that are using a Drupal theme rather than the decoupled frontend. It provides example Categories, Tags, and Publishers facet blocks that you can use with the *dkan_dataset_search* view. +This is an optional module for sites that are not using a decoupled frontend. It provides example Categories, Tags, and Publishers facet blocks that you can use with the *dkan_dataset_search* view. drush en metastore_facets @@ -10,4 +10,9 @@ If you don't see the view available, try drush cim --partial --source=modules/contrib/dkan/modules/metastore/modules/metastore_search/config/install -> :warning: **Existing sites be very careful here**: This config import will import the search view as well as new search API config. If you have custom search api configuration be sure to have it exported to code for safe keeping. To use the search view you will need to add the nid field to your configuration. + + +The search view and facets are for demonstration purposes and provide a starting step for your own implementation.