Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Commit

Permalink
Merge branch 'main' into v2-announcement
Browse files Browse the repository at this point in the history
  • Loading branch information
roll authored Jun 26, 2024
2 parents 3f1629b + 9787e62 commit b03a35c
Show file tree
Hide file tree
Showing 35 changed files with 770 additions and 1,866 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data Package

Data Package is a standard containing a set of lightweight specifications for describing datasets and individual data files. In other words, data package is a data definition language (DDL) and data API that enables and ensures data quality, accessibility, and interoperability. For more information, please visit the [documentation portal](https://datapackage.org).
Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data. For more information, please visit the [documentation portal](https://datapackage.org).

## Contributing

Expand Down
25 changes: 21 additions & 4 deletions astro.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import starlight from "@astrojs/starlight"
import { defineConfig } from "astro/config"
import rehypeAutolinkHeadings from "rehype-autolink-headings"
import { remarkHeadingId } from "remark-custom-heading-id"
import starlightBlog from "starlight-blog"

// import starlightLinksValidator from "starlight-links-validator"

// https://astro.build/config
export default defineConfig({
Expand All @@ -28,12 +31,26 @@ export default defineConfig({
lastUpdated: true,
customCss: ["/assets/styles.css"],
tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 5 },
components: {
SocialIcons: "./components/SocialIcons.astro",
},
plugins: [
starlightBlog({
authors: {
sapetti9: {
name: "sapetti9",
title: "Sara Petti",
picture: "https://avatars.githubusercontent.com/u/74717970?v=4",
url: "https://github.com/sapetti9",
},
},
}),
// The link validator is useful for debugging but it cleates a lot of false positives
// starlightLinksValidator(),
],
sidebar: [
{ label: "Overview", autogenerate: { directory: "overview" } },
{ label: "Standard", autogenerate: { directory: "standard" } },
{
label: "Specifications",
autogenerate: { directory: "specifications" },
},
{
label: "Extensions",
collapsed: true,
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
25 changes: 25 additions & 0 deletions components/SocialIcons.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
import type { Props } from "@astrojs/starlight/props"
import Default from "@astrojs/starlight/components/SocialIcons.astro"
---

<a href="/standard/data-package/" style="text-decoration: none"
><strong>v2 (current)</strong></a
>
<a href="https://specs.frictionlessdata.io/"><strong>v1</strong></a>

<!-- Render the default social links. -->
<Default {...Astro.props}><slot /></Default>

<!-- Add styles to mimic the default links appearance. -->
<style>
a {
color: var(--sl-color-text-accent);
margin: -0.5em;
padding: 0.5em;
}

a:hover {
opacity: 0.66;
}
</style>
10 changes: 6 additions & 4 deletions content/config.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { docsSchema } from "@astrojs/starlight/schema"
import { defineCollection } from "astro:content"

// import { i18nSchema } from '@astrojs/starlight/schema';
import { blogSchema } from "starlight-blog/schema"

export const collections = {
docs: defineCollection({ schema: docsSchema() }),
// i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
docs: defineCollection({
schema: docsSchema({
extend: context => blogSchema(context),
}),
}),
}
76 changes: 76 additions & 0 deletions content/docs/blog/2023-11-15-v2-announcement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: Data Package (v2) work started
date: 2023-11-15
excerpt: We are very pleased to announce that thanks to the generous support of NLnet we have kickstarted the Data Package (v2) work. After a first discussion with the community in the last call, we are setting up a working group to help us with the v2 release.
tags:
- news
authors:
- sapetti9
---

We are very pleased to announce that thanks to the generous support of [NLnet](https://nlnet.nl/) we have kickstarted the [Data Package (v2)](https://specs.frictionlessdata.io/) update.

After a first discussion with the community in [the last call](https://frictionlessdata.io/blog/2023/11/06/community-call/), we are setting up a working group to help us with the v2 release.

Taking into account the group's concerns about the shortness of the initial timeline we proposed, we were able to work out an extension of the initial time frame until mid-2024. We are now aiming at **releasing the v2 of the Frictionless specs by June 2024**.

## Goal

**Our overarching goal is to make the Frictionless specs**, namely the Data Package, Data Resource, File Dialect, and Table Schema standards, **a finished product**, establishing a sustainable mechanism for future maintenance extension.

The modular approach will of course still be the cornerstone of the Frictionless specs v2, and we won’t introduce any breaking changes.

## Additional deliverables

- Together with the working group, we will start a reference collection of data types we want the v2 to support in a GitHub issue.

- We will work with leading data publishing portals, namely CKAN and Zenodo, to provide native Data Package export integration.

- The Frictionless core team at OKFN, will work on a new small Python library, a metadata mapper, with the objective of making it simpler to create standard extensions, and being able to use it in the data publishing systems integrations (Zenodo/CKAN/etc).

- A new website and new documentation will be published, with improved technical language and better accessibility.

## Roadmap

The project roadmap will be mainly guided by the list of issues submitted by the community throughout the years, and collected [here](https://github.com/frictionlessdata/specs/milestone/6).

## Social Aspect

We will hold **monthly update calls** for the working group, which are of course not compulsory, and which will be open to the broader community too. In parallel **we will work asynchronously with the working group, using a review model** for any changes in the specifications themselves.

## Decision-making

For every GitHub issue on the specs submitted by the community throughout the years, the Frictionless core team or any working group member will propose a recommended action to the working group. The action proposed will be **accepted if consensus with the working group is reached**, meaning we have arrived at a decision, or at least a compromise, that everyone can live with.

The working group will be invited to share their view in a devoted GitHub issue. If a broader conversation is needed, the proposal discussion can be elevated to the monthly call for deliberation. The working group will be given a reasonable amount of time to review the proposed action.

**Consensus is reached and the issue is closed if at least ⅔ of the working group members participate in the discussion and express their favourable opinion**. In case of serious and explicitly stated concerns, working group members who are core library investors (at the moment: OKFN, INBO, Datopian) may veto a proposed action.

The community manager at OKFN will reach out to working group members who did not participate in the discussion to make sure their opinion is also captured. We want to ensure that reminders of your participation are handled with care. You can expect a gentle and considerate approach, such as receiving an email once every two weeks highlighting any issues where your vote is pending. Our goal is to keep you informed without causing any unnecessary inconvenience, so you can feel confident and at ease with the process

Decision-making on the technical maintenance of the specs will be centralised by OKFN.

## Diversity

Leveraging diversity is an opportunity that we must embrace for the benefits it brings. Extensive research consistently demonstrates that diverse participation leads to better outcomes and more resilient technologies — diverse communities are unequivocally stronger communities.

We acknowledge the need for greater diversity in our community, and we understand that fostering diversity, equity, and inclusion requires substantial effort. We cannot underestimate the challenges before us. Confronting the deep-rooted and centuries-old racist components of our system is a huge challenge, and we understand that achieving racial equity is a continual journey with no predefined endpoint.

Our mission is to build equity within our community, fostering inclusion and amplifying diversity across all aspects of the Frictionless project. For our specs update, we are proactively encouraging every member of the community involved in the working group to identify and invite candidates interested in contributing to the update work, with a particular emphasis on enhancing the diversity of our group.

We welcome contributors from diverse backgrounds, recognising that individuals with varied experiences bring forth new and innovative ideas that help create an inclusive and welcoming ecosystem. Our goal is to create an inclusive and friendly environment based on mutual respect and exchange, ensuring that no one feels isolated, and everyone is motivated to actively contribute to the project's development.

Acknowledging the ethical imperative, we understand that recruiting individuals into a community historically designed to exclude them is neither ethical nor effective without adequate support. We therefore prioritise transparency with new community members, providing a [contributor's guide](https://frictionlessdata.io/work-with-us/contribute/), a [published roadmap](https://frictionlessdata.io/development/roadmap/), and comprehensive documentation to ensure clarity and support throughout their engagement. Our [Code of Conduct](https://frictionlessdata.io/work-with-us/code-of-conduct/) applies to all activities linked to the Frictionless Data project, and it is enforced by our community manager. As part of this project, we will make it a priority to enhance the accessibility of our documentation and website, aiming to make them as inclusive as possible.

We welcome any other suggestions that would help us enhance diversity, equity, and inclusion in our work. Please let us know if you have a good idea to share!

## Funding

This project is funded through [NGI0 Entrust](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/FrictionlessStandards/).

[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
[<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" />](https://nlnet.nl/entrust)

:::note
Originally published on: https://frictionlessdata.io/blog/2023/11/15/frictionless-specs-update/
:::
2 changes: 1 addition & 1 deletion content/docs/guides/using-data-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:
There are many alternatives when it comes to Data Package Standard implementations. We will cover a few the most popular options which will be a good starting point.

:::tip
Please take a look at the full list of Data Package [Software](../../standard/software/) to find other implementations.
Please take a look at the full list of Data Package [Software](/overview/software/) to find other implementations.
:::

## Open Data Editor
Expand Down
46 changes: 19 additions & 27 deletions content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ hero:
<strong>simple yet extensible specifications</strong>
to describe datasets, data files and tabular data.
It is a data definition language (DDL) and data API that facilitates
<strong>data quality, accessibility, and interoperability</strong>.
<strong> findability, accessibility, interoperability, and reusability (FAIR)</strong> of data.
image:
file: ../../assets/hero.png
alt: Data Packages Illustration
actions:
- text: Get Started
link: /standard/introduction/
link: /overview/introduction/
icon: right-arrow
variant: primary
- text: Use Cases
link: /standard/adoption/
link: /overview/adoption/
icon: rocket
variant: secondary
- text: View on GitHub
Expand All @@ -29,42 +29,34 @@ hero:
banner:
content: |
<p>
The <strong>Data Package (v2)</strong> standard has been released on July 1, 2024!
The previous version is <a href="https://specs.frictionlessdata.io/" target="_blank">Data Package (v1)</a>.
The <strong>Data Package (v2)</strong> standard has been released on June 26, 2024!
Please read the <a href="/blog/2024-06-26-v2-release">announcement</a>.
</p>
---

import About from "../../components/about.astro"
import Adoption from "../../components/adoption.astro"
import ClickableCard from "../../components/clickable-card.astro"
import About from "../../components/About.astro"
import Adoption from "../../components/Adoption.astro"
import ClickableCard from "../../components/ClickableCard.astro"
import { CardGrid, LinkCard, Card } from "@astrojs/starlight/components"

<h2>Standard</h2>

The Data Package standard is a comprehensive set of **specifications** that collectively define a framework for organizing, documenting, and sharing data in a structured and interoperable manner -- [EXPLORE THE STANDARD](/standard/specifications)
The Data Package standard is a comprehensive set of **specifications** that collectively define a framework for organizing, documenting, and sharing data in a structured and interoperable manner -- [EXPLORE THE STANDARD](/standard/data-package)

<CardGrid>
<ClickableCard
title="Data Package"
icon="open-book"
href="/specifications/data-package"
>
<ClickableCard title="Data Package" icon="open-book" href="/standard/data-package">
A simple container format to describe a coherent collection of data (a dataset),
including its contributors, licenses, etc.
</ClickableCard>
<ClickableCard title="Data Resource" icon="rocket" href="/specifications/data-resource">
<ClickableCard title="Data Resource" icon="rocket" href="/standard/data-resource">
A simple format to describe a data resource such as a individual table or file,
including its name, format, path, etc.
</ClickableCard>
<ClickableCard
title="Table Dialect"
icon="document"
href="/specifications/table-dialect"
>
<ClickableCard title="Table Dialect" icon="document" href="/standard/table-dialect">
A simple format to describe the dialect of a tabular data file, including its
delimiter, header rows, escape characters, etc.
</ClickableCard>
<ClickableCard title="Table Schema" icon="puzzle" href="/specifications/table-schema">
<ClickableCard title="Table Schema" icon="puzzle" href="/standard/table-schema">
A simple format to describe tabular data, including field names, types, constraints,
missing values, foreign keys, etc.
</ClickableCard>
Expand All @@ -74,15 +66,15 @@ The Data Package standard is a comprehensive set of **specifications** that coll

<h2>Software</h2>

Data Package is backed by a suite of software tools supporting the standard. From the no-code visual tool **Open Data Editor** to low-level drivers for 10 programming languages -- [EXPLORE THE SOFTWARE](/standard/software)
Data Package is backed by a suite of software tools supporting the standard. From the no-code visual tool **Open Data Editor** to low-level drivers for 10 programming languages -- [EXPLORE THE SOFTWARE](/overview/software)

[![Open Data Editor](../../assets/software/ode.png)](https://opendataeditor.okfn.org)

<div style="margin-bottom: 5em"></div>

<h2>Adoption</h2>

Data Package is used for a wide range of scenarios where this standardized data packaging format proves invaluable for efficient data management, sharing, and analysis -- [EXPLORE THE ADOPTION](/standard/adoption)
Data Package is used for a wide range of scenarios where this standardized data packaging format proves invaluable for efficient data management, sharing, and analysis -- [EXPLORE THE ADOPTION](/overview/adoption)

<Adoption />

Expand All @@ -93,10 +85,10 @@ Data Package is used for a wide range of scenarios where this standardized data
Read the Data Package documentation to learn more about the standard:

<CardGrid>
<LinkCard title="Specifications" href="/standard/specifications" />
<LinkCard title="Extensions" href="/standard/extensions" />
<LinkCard title="Recipes" href="/standard/recipes" />
<LinkCard title="Guides" href="/standard/guides" />
<LinkCard title="Standard" href="/standard/data-package" />
<LinkCard title="Extensions" href="/extensions/camtrap-data-package" />
<LinkCard title="Recipes" href="/recipes/caching-of-resources" />
<LinkCard title="Guides" href="/guides/using-data-package" />
</CardGrid>

<About title="Brought to you by">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
---

import { adoption } from "../../../assets"
import ImageLinkCard from "../../../components/image-link-card.astro"
import ImageLinkCard from "../../../components/ImageLinkCard.astro"
import { LinkCard, CardGrid } from "@astrojs/starlight/components"

:::tip[Contribution Note]
Expand Down
Loading

0 comments on commit b03a35c

Please sign in to comment.