Code Monkey home page Code Monkey logo

website-old's Introduction

Frictionless Data Website

Build Status

This is the Frictionless Data website, hosted at https://frictionlessdata.io

Contributing

  • Install Lektor
  • Install a recent Node
  • npm install
  • npm run build
  • lektor server

Updating the specs

  • update package.json:specsBranchOrTag
  • run npm run build

See the Open Knowledge Foundation coding standards, which apply for contributions to this website.

Contributing Translations

We are keen on having Frictionless Data content translated and made available in different languages. Here is how to submit your content translations for review:

Open an issue

  • Open a new issue
  • Specify pages that have been translated, and provide a link to the translated content

As a Pull Request

  • Clone this repository.
  • Find the folder that has content you want to translate
  • Create a contents+LANG.lr file in the folder above, where LANG is the two-letter ISO-code of the language you want to translate content to i.e. fr for French, sw for Swahili, zh for Chinese, etc
  • Add your translated text in the file above, in Markdown format.
  • Submit a pull request.

Your submission will then undergo a review process, and once edits and suggestions have been incorporated, your translation will be added to the Frictionless Data website.

All content on the Frictionless Data website is made available under the CC-BY license.

CSS

Style changes should be made to the SCSS files. Use grunt to watch for changes, and compile to CSS.

Notes

If you get errors like below, ensure that there are not codeblocks in content with mentioned syntax (yaml= in this case). Make sure that you npm run build before checking to pull the latest specs documents. Lektor errors could be confusing because we use the TOC plugin - so it could show the same error for all documents while the real error is only inside one of them.

E index.html (ClassNotFound: no lexer for alias u'yaml=' found)

website-old's People

Contributors

akariv avatar amercader avatar augusto-herrmann avatar danfowler avatar emmabeer avatar higa4 avatar higa4-grp avatar jobarratt avatar joetsoi avatar katerogers avatar lwinfree avatar mariekeguy avatar michaelamadi avatar monikappv avatar morchickit avatar napo avatar nyampire avatar optikfluffel avatar patriceblain avatar phochste avatar pwalsh avatar roll avatar rufuspollock avatar serahkiburu avatar smth avatar stephen-gates avatar tkaneda avatar vitorbaptista avatar yoshikazukashiwazaki avatar ytk-mt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

website-old's Issues

Presentation: SciDataCon: Towards a Frictionless Data Future [International Data Week]

  • Introduction to Open Knowledge International
  • Introduction to Frictionless Data and Data Packages
    • In-depth intro to JSON Table Schema
      • Highlight missingValue, constraints, enum (as controlled vocab)
  • Current Libraries/Integrations
    • Python Pandas
    • R
    • CKAN
  • Current Partners
    • Dataship
    • DM4T
    • rOpenSci
    • WPRDC
  • Call To Action
    • Create a Pilot with Us
    • Join Mailing List

WIP: https://docs.google.com/presentation/d/1thmb3N2s_TD-UxugZTC26yXzxP-miS9r2QMI2E9DFJM/pub?start=false&loop=false&delayms=3000

Ideas for roadmap page

From @pwalsh on March 30, 2015 9:4

Some ideas for the current roadmap page (a brain dump): http://data.okfn.org/roadmap

  • Relationship between tools/specs/community on this page, and the Tools and Standards pages proper
    • Maybe need a new object type in Jekyll that describes standard <> tooling <> community, and this can be used across site
  • Tooling would be useful to group by language, and or indicate lang with icons. Tools that have CLIs should also be indicated clearly (due to potential for language agnostic use)
  • Document a clear way to add tooling (user story: I just wrote a JTS validator in php - how do I add it to the list?)

Copied from original issue: frictionlessdata/frictionlessdata.io#168

IP policy and terms of use

Handbook theme should link to IP policy as well as terms of use ... (and that should then be pulled through to here)

Improve theme

I'm booting this issue as an ongoing place to discuss some goals for v2 of the theme.

  • Really nice styling for HTML tables for the inevitable multitude of simple examples of tabular data.
  • There will be a fair amount of code examples, so it would be nice to have a really nice styling for code snippets.

suggestions from #10 (also see coments):

  • Really concerned about "invisibility" of side menu and lack of top menu
    • For handbook this style made sense as more book like but we will need a more normal top menu here I think.
  • bootstrap "boxes" stuff for e.g. /tools/ and some of /guides/ - see old http://data.okfn.org/tools/ for example
    • support fancy buttons

New Section: How Do Data Packages Compare To...

A typical question when explaining the concept of Data Packages to people who already have some familiarity with "containerization", "metadata", and schema languages is how Data Packages compare, especially when considering the work involved in supporting an additional standard.

A comparison table listing the features supported by different formats seems like a good place to point people. In addition, it could make clear potential ways in which two standards can complement each other.

Potential comparisons to make:

Related: frictionlessdata/frictionlessdata.io#274

First pass on /guides/ section

  • Import most of the /doc/ stuff from data.okfn.org - but put refactor structure to have directory approach e.g. /doc/publish/tabular/ rather than /doc/publish-tabular/
  • Fix up the bootstrap row stuff in /doc/ ... now in #10
  • Merge guides with doc stuff

[super] Use Cases and User Story Epics

From @danfowler on May 6, 2016 11:9

Epics:

  • Validate the data - #251
  • Describe the data - describe the columns, provide general metadata - #254
  • Import the data (into my tool)
  • Share the data
    • Email
    • Post online
    • Publish to Wordpress, Google Drive etc

  • Enrich / Merge data (join two datasets together on a single field)
  • Present the data (on my website)
    • Super Simple Data Catalog
  • Publish the data to a catalog / repository (to a particular platform)
    • Publish to CKAN, DSpace, etc

  • Example: Data dependencies and automatically installing a lot on your machine

Where

List under http://frictionlessdata.io/user-stories/

Copied from original issue: frictionlessdata/frictionlessdata.io#245

[super] Workflow for Creating a Data Package

From @rgrp on April 30, 2016 20:10

Overview of workflow for creating a Data Package (and associated tools and tutorials)

Rough flowchart:

  • Type of data - Tabular / Geo / Any
  • Are you using a library or tool or are you doing by hand
    • ? Python / R / ... =>
    • Doing it by hand => ...

This could start as a simple diagram ... - would go on /guides/publish/ page

Copied from original issue: frictionlessdata/frictionlessdata.io#229

Feedback for Quick start in Python page

@danfowler I think it provides a good overview, just some comments:

  • Storage libraries names are wrong: pip install jsontableschema_sql -> pip install jsontableschema-sql. Same for BigQuery.
  • Badly formatted link: For more information on which fields are supported, see [the full Data Package standard][dp-spec].
  • I was surprised to see how the guide jumped straight from checking the metadata to store the data on an external backend. My first though was how do I see the actual data on the Data Package object? I think it's worth having a section between "Reading basic metadata" and "Loading into an SQL database" named "Reading the data" or something which shows an example like:
print [e['name'] for e in dp.resources[0].data if int(e['atomic number']) < 10]
[u'Hydrogen', u'Helium', u'Lithium', u'Beryllium', u'Boron', u'Carbon', u'Nitrogen', u'Oxygen', u'Fluorine']

And also mentions any other form of accessing the data directly on python (like lazily with iter)

[super] Publishing data tutorials / patterns

From @rgrp on December 1, 2013 20:28

Common:

Copied from original issue: frictionlessdata/frictionlessdata.io#91

/tools/ page

  • Migrate current data.okfn.org/tools with minor refactoring
  • Short summary about why tools are essential (?)
  • Key online services that you an use (e.g. create, view, validate, validate data)
  • Guides - using Data Packages with ...
  • Tool catalog - long list. Need to add:
    • Language or Platform
    • Organisation

[meta] Diagram Ideas - Library Architecture, Spec Relationships etc

From @rgrp on May 2, 2016 8:58

  • Data management pipeline and relationship to Frictionless Data tooling
  • User story overview and relation to components
  • Data Package Tool Stack

High level user story + components view

https://docs.google.com/drawings/d/1uZhzgc43j8tQuN3MD5IoRdKUT192fvjDefNq85HtSU4/edit

## Data Package Tool Stack

See: https://discuss.okfn.org/t/data-package-libraries-overview/957

## Frictionless Data Roadmap

https://docs.google.com/drawings/d/1td7wmG54wbxCpS7kb5clPLyqESwHHTBvuxlIIRd-x5k/edit

## Data Package "Specs"

https://docs.google.com/drawings/d/1SZxJ00WEp3iK5fqljc-yumalRePmwdaaH98_8uJYlbs/edit

## Data Packages and Ecosystem (old)

https://docs.google.com/drawings/d/1W0s91bQGS-bmGOLm519mMq9zDJvRhP71pwuJtkflRws/edit


Ideas from Elsewhere

"Lego bricks"

For describing how specs or tools fit together e.g.

                Tabular Data Package
    |                                   |
---------   Data Descriptor ---------   |
Data Package | JSON Table Schema | CSV

image

From: https://coreos.com/

Copied from original issue: frictionlessdata/frictionlessdata.io#235

[meta] Information Architecture and Overall Plan

Planning issue for describing the overall information architecture of Frictionless Data Site(s)

Note: use "fd[.io]" as shorthand for "frictionlessdata[.io]

Sites and subsites

  • fd.io/ - main site, most information lives here. Detailed description below.
  • specs.fd.io - specifications site - see frictionlessdata/frictionlessdata.io#242
  • profiles.fd.io - profiles registry
  • tools.fd.io ?? stuff like validate etc - may just have validate.fd.io

fd.io

/
# all general documentation
# thought about putting this under other items but think we want to centralise
/doc/

/data-packages/
  # maybe /standards/ - summary and link elsewhere
  /specs/
  /profiles/

/tools/

# roadmap and developer stuff - maybe merge with community
/develop/

# community stuff
/community/

# get help ...
/help/

/about/
/blog/ -> labs (or blog.okfn.org one day)

/

  • Find out more
  • Data Packages
  • Tools
  • Benefits
  • Testimonials
  • Get Started
  • Get help

/data-packages/

  • publish
  • find
  • use

/doc/

# index - want this to be good but maybe we can autogenerate ...
/

# guides to the specs
/data-package/
/tabular-data-package/
/geo-data-package/

# actually get started
/publish/
/publish/tabular/
/publish/geo/

# "patterns" and general howtos go here
/publish/faq/
/publish/faq/.../

# move these under /ref/ (for reference) ??
/csv/
/geojson/

/data-packages/

  • what are they - simple little diagram ...
  • publish, find, use - sort of data.okfn.org front page
  • mainly link elsewhere ...

/tools/

Big box at top: "Have something to add: edit this page on github or submit an issue here."

Nice listing of tools. Not a table but we do want a table of contents.

Structure options:

  • Function (e.g. validate, model etc)
  • Platform / language

Right now suggest we structure as follows:

## Top: Set of key functions with link to best tool

## By Function
  - items in here link to below

// might just drop this section and people can look in sections below

## Integrations

## Libraries

## Services

/community/

Get involved, find people, develop the project

(other possible names: /contribute/ or /develop/)

  • forum
  • report issues
  • chat channel
  • twitter (labs)
  • github (the organization) or perhaps github.com/frictionless

/help/ (or maybe /support/)

Community Support -> forum

Paid Professional Support

Professional level training and support as well as custom development is available from Open Knowledge Services team. Please see http://services.okfn.org/

/search/

/search/ - put a search box on site in navbar if possible (or sidebar)

Google custom search. Search this site, plus specs + labs blog (specific category ...?)

/about/

About page. Partners etc.

Rendering issue in Chrome

The frictionlessdata tab in the top-right doesn't render correctly in Safari. I was able to fix it by disabling the transform property. I believe it's caused by the perspective transform overriding the zindex

screenshot 2016-05-02 17 18 21

screenshot 2016-05-02 17 18 28

/data-packages/

  • move /standards/ => /data-packages/
    • Why? Because all the standards / spec stuff is about data package and this is much conceptually accurate plus better link naming for SEO
  • redo page to be like front page but about data packages (??)
    • later we should replace the image and not reuse front page image
  • Draw some decent diagrams - see #8 for diagram ideas
    • Current diagram is pretty poor
    • Suggest at least one lego diagram + the general diagram about separation of concerns (though not sure that is super clear and maybe should be in benefits section here or elsewhere)
  • Subpages
    • specs
    • profiles

Notes

  • Make JTS more prominent e.g. /data-packages/json-table-schema/

Asides:

Example - House prices regressed on long interest rate and GDP (and population)

From @rgrp on April 6, 2013 15:40

  • R example
  • (Maybe we do in other languages too later ...)

What does it demonstrate: quickly getting data and using it together

Required data

Do we need this quarterly?

Why this analysis

  • People are interested in house prices - why do they go up and down
  • Classic explanation is other economic variables e.g. demand (GDP, population and interest rate (mortgages)), supply (housing stock). Here will just use demand variables and see what we find.

Copied from original issue: frictionlessdata/frictionlessdata.io#32

Sprint 25 April - 2nd May 2016

Read Information Architect overview first: #2

Bigger Stuff

In approximate priority order:

Probably not this iteration:

  • / - improvements to front page

Misc

  • Hide "donate", "share" buttons on all pages (not really needed for this type of site) (may as well leave these ...)
  • Show "edit this page" button by default (in _config.yml) and then turn off where needed
  • Update the README to something sensible
  • Handbook theme should link to IP policy as well as terms of use ... (and that should then be pulled through to here)
  • Create sections to break up sidebar ToC a bit (??) - not a priority as will probably reflect overall architectute

Theme for v1

  • Really concerned about "invisibility" of side menu and lack of top menu
    • For handbook this style made sense as more book like but we will need a more normal top menu here I think.
  • bootstrap "boxes" stuff for e.g. /tools/ and some of /guides/ - see old http://data.okfn.org/tools/ for example
    • support fancy buttons

Data Package Specifications Intro v2

From @rgrp on May 17, 2016 8:49

Specifications page is now http://frictionlessdata.io/data-packages/

We need to spec out this page and then implement.

Thoughts

Copied from original issue: frictionlessdata/frictionlessdata.io#255

Tutorial: Publish Data Package from Google Spreadsheet

From @rgrp on April 6, 2013 15:39

More of a blog post than something on the site (publish on e.g. okfnlabs.org). Think this is pretty useful.

Walk through of turning a google spreadsheet into a data package

  • publish to the web
  • get public CSV url for relevant sheet
  • create datapackage.json (cf #28) and publish it somewhere
    • this is an important one - should we make this part of data.okfn.org itself (cf #52 - community catalog). Simplest option would be gist or even pasting the json into a google doc and getting raw text url for that (seems quite clunky!)

cf #30 (google spreadsheet export tool)

Cost: 2-3h

Copied from original issue: frictionlessdata/frictionlessdata.io#31

[super] Continuous Data Integration workflows around Data Packages

From @rgrp on October 12, 2015 17:17

For a long time we've discussed "continuous data integration" and doing this with Data Packages. This is a discussion space for these ideas.

What do we mean by "Continuous Data Integration"?

Continuous Integration with code means automated running of tests (and sometimes deployments) whenever new code is pushed.

For data, this would mean automatically validating (testing) data and metadata on each new contribution and running any deployment tests.

Automatically validating a Data Package data against its schema on each commit (assuming the data was stored in git)

Sub parts

Initial Implementation

We could start out piggy-backing on existing code CI services such as Travis: instead of running code test we run data validate tests as a code test.

By hand version

  • create a demo repo - probably clone a core data package dataset
  • implement a tiny test script in scripts called datatest.py or similar. Use goodtables to test the data
  • turn on travis ci and run the test script
    • bonus points for somehow showing pretty output from goodtables

Standardize:

Copied from original issue: frictionlessdata/frictionlessdata.io#198

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.