Skip to content

Commit

Permalink
updated "CEH" to "UKCEH" in markdown docs because it was annoying me
Browse files Browse the repository at this point in the history
  • Loading branch information
phtrceh committed Aug 2, 2024
1 parent 5897cf8 commit 9ddf603
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# CEH Catalogue

The CEH metadata catalogue project.
# UKCEH metadata catalogue

[Introduction for developers](docs/introduction.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Lots of services that do stuff.
Decoupling the work of actually doing something from the HTTP code to ease testing and developer comprehension.

#### sparql
Retrieve vocabularies from a SPARQL endpoint like the [CEH Vocabulary Service](https://vocabs.ceh.ac.uk)
Retrieve vocabularies from a SPARQL endpoint like the [UKCEH Vocabulary Service](https://vocabs.ceh.ac.uk)

#### upload
Upload data to the Storage Area Network (SAN), interacts with Hubbub to specify where files should be moved to.
Expand Down
6 changes: 3 additions & 3 deletions docs/new-catalogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Catalogue.builder()
* you can have a chain of these e.g. `.documentType(documentTypeA).documentType(documentTypeB)`
* *fileUpload*
* if `true` then you can upload documents, you see this when you go to <http://location:8080/your-id/documents> and click `create` then select `file-upload`.
Most of the time it should be `false`
Most of the time it should be `false`

### Search facets
There are many fields already indexed in Solr that can be used as search facets.
Expand All @@ -49,12 +49,12 @@ There are many fields already indexed in Solr that can be used as search facets.

If the existing index fields are not suitable a new index field can be added.

The content of a search facet needs to come from a vocabulary, [CEH Vocabularies](http://vocabs.ceh.ac.uk/) is a good home.
The content of a search facet needs to come from a vocabulary, [UKCEH Vocabularies](http://vocabs.ceh.ac.uk/) is a good home.
The metadata records need to be tagged with the keywords.

The facetKey needs to be added to the [Solr schema](../solr/config/documents/conf/schema.xml) and the [SolrIndex](../java/src/main/java/uk/ac/ceh/gateway/catalogue/indexing/SolrIndex.java)

The documents need to be indexed for each document type in the catalogue e.g. [SolrIndexGeminiDocumentGenerator](../java/src/main/java/uk/ac/ceh/gateway/catalogue/indexing/SolrIndexGeminiDocumentGenerator.java) for Gemini documents and [SolrIndexImpDocumentGenerator](../java/src/main/java/uk/ac/ceh/gateway/catalogue/indexing/SolrIndexImpDocumentGenerator.java) for models / model applications.
The documents need to be indexed for each document type in the catalogue e.g. [SolrIndexGeminiDocumentGenerator](../java/src/main/java/uk/ac/ceh/gateway/catalogue/indexing/SolrIndexGeminiDocumentGenerator.java) for Gemini documents and [SolrIndexImpDocumentGenerator](../java/src/main/java/uk/ac/ceh/gateway/catalogue/indexing/SolrIndexImpDocumentGenerator.java) for models / model applications.

- Add the url of the vocabulary
- Set the newly added field of the SolrIndex
Expand Down

0 comments on commit 9ddf603

Please sign in to comment.