Creating a dataset using Octopub couldn't be easier. Before getting started, make sure you've got a Github account. If you haven't got one, you can sign up at github.com/join. Once you've got an account, follow along with our video tutorial or via the steps below. follow our simple step by step guide to creating your first dataset.
Step by Step: Using Octopub
First, go to the homepage and click 'Sign in with Github'
If you’re not already logged into Github, you’ll be prompted to sign in to your Github account.
Once you're signed in, you’ll see a screen like this, asking you to authorise your account with Octopub. We need these permissions to create and update datasets in Github on your behalf, and won’t use them for any other purpose:
Next, click ‘Authorize application’.You’ll then be redirected to Octopub with a message telling you you’re logged in.
Next, under the ‘Datasets’ menu, click ‘Add a dataset’. You’ll then be redirected to the dataset creation page:
The first thing you’re asked for is the title of the dataset. Keep this short, sweet and descriptive, telling users what the dataset is about.
Next is the description, you can use this to give extra context to the data. This can be as long or as short as you'd like
Now, provide the name and web address of the person of organisation who is publishing the data. Data users like this, so they know who to contact with any questions.
Next, you can choose the license. This lets people know what they can or can't do with the data
The license options are as follows:
Creative Commons Attribution 4.0
Creative Commons Attribution Share-Alike 4.0
Open Government License 3.0 (United Kingdom)
Open Data Commons Attribution License 1.0
Open Data Commons Public Domain Dedication and License 1.0
For more information of open data licensing, see the ODI’s guide to open data licensing.
You can also choose whether to publish your data privately or publicly. Only people with paid Github accounts can publish privately, so leave this to 'yes' for now.
Next, choose how often you think the data will be updated - this lets data reusers know if this data is likely to change
Now comes to nitty gritty part, adding the data. Choose a title and description for your data file, then click 'Choose file' to choose a CSV file to upload.
Once the file has uploaded, you can scroll down and click 'Submit' to create your dataset. You'll then see a notice telling you your data has been queued for creation. Within a few minutes, you should recieve an email, with a link allowing you to see your dataset in all its glory!
For more information and advanced topics, visit the Octopub wiki pages.