diff --git a/docs/markdowns/api-doc/references.md b/docs/markdowns/api-doc/references.md index 3d7c8f34..1d66cd21 100644 --- a/docs/markdowns/api-doc/references.md +++ b/docs/markdowns/api-doc/references.md @@ -1,9 +1,13 @@ - # 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 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 + 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 organization = { name: "some org name", @@ -11,7 +15,9 @@ organization = { description: "A description of the organization" } ``` + An example of dataset with organization properties is given below: + ```javascript datasets = [{ organization: { @@ -30,9 +36,10 @@ datasets = [{ ``` ### Resource + TODO -### view spec +### View spec --- @@ -45,11 +52,3 @@ TODO ### Single Dataset with Default Theme ![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).