Skip to content

Commit

Permalink
Merged with website
Browse files Browse the repository at this point in the history
  • Loading branch information
roll committed Sep 12, 2022
1 parent fccce1f commit 17f8076
Show file tree
Hide file tree
Showing 625 changed files with 38,760 additions and 2,583 deletions.
14 changes: 2 additions & 12 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
Please replace this line with full information about your idea or problem. If it's a bug share as much as possible to reproduce it.
# Overview

Job story if there is one ...

## Acceptance

* [ ] ...

## Tasks

* [ ] ...

## Analysis
Please replace this line with full information about your idea or problem. If it's a bug share as much as possible to reproduce it
23 changes: 23 additions & 0 deletions .github/stale.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 90

# Number of days of inactivity before a stale issue is closed
daysUntilClose: 30

# Issues with these labels will never be considered stale
exemptLabels:
- feature
- enhancement
- bug

# Label to use when marking an issue as stale
staleLabel: wontfix

# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
44 changes: 44 additions & 0 deletions .github/workflows/general.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: general

on:
push:
branches:
- main
tags:
- v*.*.*
pull_request:
branches:
- main

jobs:

# Test

test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Configure
run: npm install
- name: Build
run: npm run build

# Deploy

deploy:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: [test]
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Configure
run: npm install
- name: Build
run: npm run build
- name: Deploy
uses: JamesIves/[email protected]
with:
branch: site
folder: site/.vuepress/dist
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
node_modules/*
site/.vuepress/dist/*
sandbox/*
.env

.vercel
110 changes: 110 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Contributing

The website contribution guide.

## Frontmatter

Frontmatter is the metadata in pages. It is an essential "API" between content authors and the theme designers. Here you can find the frontmatter definitions for main category of pages.

### Common for all pages

This frontmatter is common to all pages and maybe used in any of them. Every page MUST have a title. All other values are optional.

```md
---
title: # the title of the page
description: # short description / summary / excerpt
tagline: # one sentence summary
image: /data-package-diagram.png
layout: product | job [| blog]
---
```

* `layout`: You only need to set layout if you need a custom layout. Default pages don't need it, nor does the blog section (layout for blog pages is set automatically by the blog plugin)
* `image`: only needed if you have a primary image for this page that is going to be used elsewhere. For example, for the blog, this is the featured image that is used on the blog listing page.
* `description`: you can set this explicitly in the frontmatter OR you have this automatically generated by using the `<!-- more -->` tag as per https://v1.vuepress.vuejs.org/theme/writing-a-theme.html#content-excerpt
* If set, the description will be used to set the meta description tag.
* `tagline`: this is rarely used as you have title and description. TODO: specify which page types use this.

### Page titles

Our convention is that page titles are set in frontmatter not in markdown. This allows them to be styled different etc.

:white_check_mark:

```md
---
title: My Page
---

This page is about X ...
```

:x:

```md
# My Page

This page is about X
```

### Blog posts

```md
---
category: case-studies | grantee-profiles | pilots | grantee-profiles-2019
date: # date of publication in yyyy-mm-dd format
author:
tags: ["pilots", "case-studies"]
---
```

#### Author

Author can be for single or multiple authors. A single author is a single value:

```
author: Rufus Pollock
```

Multipe authors is an array of values:

```
author:
- Rufus Pollock
- Lilly Winfree
```

#### Category


When category == "case-studies" | "pilots"

```md
interviewee:
subject_context:
```

When category == "grantee-profiles"

```md
github:
twitter:
website:
```

### Jobs pages

```md
tagline:
pain:
context: (?)
hexagon:
```

### Product pages

```md
hexagon:
github: # list of github repos ...
```
1 change: 1 addition & 0 deletions LEAD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
roll
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2020 Open Knowledge Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Frictionless - Project Management
# Frictionless Data

This is a repo for managing the Frictionless project – https://frictionlessdata.io/
[![Build](https://img.shields.io/github/workflow/status/frictionlessdata/website/general/main)](https://github.com/frictionlessdata/frictionlessdata.io/actions)
[![Codebase](https://img.shields.io/badge/codebase-github-brightgreen)](https://github.com/frictionlessdata/frictionlessdata.io)
[![Support](https://img.shields.io/badge/support-slack-brightgreen)](https://join.slack.com/t/frictionlessdata/shared_invite/zt-17kpbffnm-tRfDW_wJgOw8tJVLvZTrBg)

As such it is more core team focused. :smile:
This is a repo for managing the Frictionless project – https://frictionlessdata.io/. As such it is more core team focused. :smile:

* Frictionless Data: https://frictionlessdata.io/
* Specifications: https://specs.frictionlessdata.io/
Expand All @@ -21,3 +23,18 @@ Want to cite this repo? Please use this DOI:
* Also the catch-all for general questions, suggestions, ideas, support requests, etc.
* **Project**: https://github.com/frictionlessdata/project/issues – the default place for core team to organize and plan work, schedule sprints, etc. **NOT** for general discussion, ideas, support, etc.
* **Specs**: https://github.com/frictionlessdata/specs/issues

## How to contribute to the website

This is the new FrictionlessData.io website to be released in 2020. It reflects the recent updates made to Frictionless Data project setup and brand.

### Development

```console
$ npm install
$ npm start
```

### Deployment

New commits into the master branch will be automatically deployed to GitHub Pages by a [workflow](.github/workflows/general.yml).
Loading

0 comments on commit 17f8076

Please sign in to comment.