datahub/site/content/docs/references.md
Rufus Pollock 22648a0528 [site,#572][s]: refactor existing site content into the content directory.
* Can get rid of existing pages as now our generic markdown / mdx loader at the root \[...slug\].js catches everything
* Convert gallery to a markdown file
2021-07-28 23:23:28 +02:00

1.4 KiB

Concepts and Terms

In this section, we explain some of the terms and concepts used throughtout the portal.js documentation.

Some of these concepts are part of official specs, and when appropriate, we'll link to the sources where you can get more details.

Dataset

A dataset extends the Frictionless data package to add an extra organization property. The organization property describes the organization the dataset belongs to, and it should have the following properties:

organization = {
 name: "some org name",
 title: "Some optional org title",
 description: "A description of the organization"
}

An example of dataset with organization properties is given below:

datasets = [{
    organization: {
     name: "some org name",
     title: "Some optional org title",
     description: "A description of the organization"
    },
    title: "Data package title",
    name:  "Data package name",
    description: "description of data package",
    resources: [...],
    licences: [...],
    sources: [...]
    }
]

Resource

TODO

View spec


Deploying portal build to github pages

Showcases

Single Dataset with Default Theme

Single Dataset Example