knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[site/docs/references][xs]: markdown formatting.

Browse Source
This commit is contained in:
Rufus Pollock
2021-06-19 20:26:33 +02:00
parent 12b830f1e5
commit bb202e1828
1 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/markdowns/api-doc/references.md
View File

@@ -1,9 +1,13 @@
# Concepts and Terms # Concepts and Terms
In this section, we explain some of the terms and concepts used throughtout the portal.js documentation. In this section, we explain some of the terms and concepts used throughtout the portal.js documentation.
> Some of these concepts are part of officila specs, and when appropriate, we'll link to the sources where you can get more details.
> 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 ### Dataset
A dataset extends the [Frictionless data package](https://specs.frictionlessdata.io/data-package/#metadata) to add an extra organization property. The organization property describes the organization the dataset belongs to, and it should have the following properties: A dataset extends the [Frictionless data package](https://specs.frictionlessdata.io/data-package/#metadata) to add an extra organization property. The organization property describes the organization the dataset belongs to, and it should have the following properties:
```javascript ```javascript
organization = { organization = {
name: "some org name", name: "some org name",
@@ -11,7 +15,9 @@ organization = {
description: "A description of the organization" description: "A description of the organization"
} }
``` ```
An example of dataset with organization properties is given below: An example of dataset with organization properties is given below:
```javascript ```javascript
datasets = [{ datasets = [{
organization: { organization: {
@@ -30,9 +36,10 @@ datasets = [{
``` ```
### Resource ### Resource
TODO TODO
### view spec ### View spec
--- ---
@@ -45,11 +52,3 @@ TODO
### Single Dataset with Default Theme ### Single Dataset with Default Theme
![Single Dataset Example](./examples/dataset-frictionless/assets/demo.gif) ![Single Dataset Example](./examples/dataset-frictionless/assets/demo.gif)
---
# Appendix
## What happened to Recline?
Portal.JS used to be Recline(JS). If you are looking for the old Recline codebase it still exists: see the [`recline` branch](https://github.com/datopian/portal.js/tree/recline). If you want context for the rename see [this issue](https://github.com/datopian/portal.js/issues/520).