Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
janette committed Jan 5, 2024
1 parent c0bbf1a commit 56b5977
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/source/developer-guide/dev_search.rst
Original file line number Diff line number Diff line change
@@ -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_
9 changes: 7 additions & 2 deletions modules/metastore/modules/metastore_facets/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
<aside class="admonition warning">
<p class="admonition-title">Existing sites be very careful here</p>
<p>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.</p>
</aside>

The search view and facets are for demonstration purposes and provide a starting step for your own implementation.

0 comments on commit 56b5977

Please sign in to comment.