Project

General

Profile

« Previous | Next » 

Revision 7501

add solr index documentation outline. http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5884

View differences:

docs/user/metacat/source/query-index.rst
1
Metacat Indexing
2
===========================
3
Lorem ipsum
4

  
5
SOLR background information
6
---------------------------
7
Features:
8

  
9
* something
10
* something
11
* more
12
* even more
13

  
14
Something to explain the advantage of solr over the old metacat index approach
15

  
16
Indexed documents and fields
17
-----------------------------
18
Metacat reuses the default DataONE index which includes many common metadata formats
19
out-of-the-box
20

  
21
1. EML
22
2. FGDC
23
3. Dryad
24

  
25

  
26
Default indexed fields
27
-----------------------
28
Describe the existing fields like in the DataONE docs, with link to them
29

  
30

  
31
Index configuration overview
32
----------------------------
33
Describe the configuration files and extension points for the implementation
34

  
35

  
36
Adding additional document types and fields
37
--------------------------------------------
38
Step-by-step guide for adding new documents and indexed fields.
39

  
40

  
41
Querying the index
42
--------------------
43
Provide example SOLR queries and expected results. Show a variety of return types
44
and query facets.
45

  
46

  
47
Access Policy enforcement
48
-------------------------
49
Explain how access control is processed and honored when utilizing the index.
50

  
51

  
52
Regenerating the index from scratch
53
-----------------------------------
54
When the SOLR index has been drastically modified, a complete regenration of the 
55
index may be necessary. In order to accomplish this:
56

  
57
Step-by-step instructions
58

  
59
NOTE: this may take a long time depending on the size of your Metacat store.

Also available in: Unified diff