Create a New Site¶
Sites are stored in the sitesDir which is stored in the root directory’s config.yml file. The default sites directory is ./sites.
Use Plop Generator¶
A new site can be created using plop: node_modules/.bin/plop.
Create a Site Manually¶
New sites can be created manually by copying the “test-site” in ./internals/models/tests/sites/test-site.
Use Catalog Admin¶
Interra Catalog Admin includes a user interface for creating and editing sites.
Validating Sites¶
To validate your site configuration type: node cli.js validate-site SITE.
Site Configration¶
Below is a description of the site configuration file: config.yml.
Properties
| Type | Description | Required | |
|---|---|---|---|
| name | string |
The name of the site | Yes |
| schema | string |
The schema of the site | Yes |
| identifier | string |
Unique ID of the site | Yes |
| description | string |
Description of the site | No |
| search | string |
Search settings of the site | Yes |
| private | object |
Private settings of the site | No |
| front-page-ic on-collection | string |
The collection to be used for front page icons | No |
| front-page-ic ons | array[] |
The icons to be used for front page icons | No |
| fontConfig | object |
Configuration object for fonts | No |
Additional properties are allowed.
schema¶
The schema of the site
- Type:
string - Required: No
- Allowed values:
"pod-full""pod""test-schema"
search¶
Search settings for the site.
type:
The search engine to use for the site. Options include elasticLunr, elasticSearch, and simpleSearch
- type:
string - required: Yes
fields:
The fields to include in the search.
- type:
array - required: Yes
endpoint:
Endpoint for Elastic Search or other remote search backend
- type:
string - required: no
- format: uri
private¶
Private settings for the site that are not exported to the production instance. Includes settings for AWS and other services
front-page-icon-collection¶
The collection to be used for front page icons
- Type:
string - Required: No