Data Together Learning Materials

This primer introduces key concepts for community-based data stewardship and contains a series of tutorials explaining Data Together and showing how to add content to the network, annotate content that’s already on the network, and reinforce content that is already stored on the network.

As a GitBook, it can be read in many different formats.

License

Data Together Learning Materials are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

See the LICENSE file for details.

Getting Involved

We would love involvement from more people! If you notice any errors or would like to submit changes, please see our Contributing Guidelines.

We use GitHub issues for tracking bugs and feature requests and Pull Requests (PRs) for submitting changes

...

[Optional section(s) on Installation (actually using the service!), Architecture, Dependencies, and Other Considerations]

First Steps

Check out the Table of Contents or the sidebar on the left. Topics are broken down into Tutorials with distinct Lessons within each!

The first tutorial covers adding a dataset to Data Together and reviews how Data Together is different from other forms of preserving data.

Getting Help

You can get help by any of the following methods:

add a question to the datatogether/learning issue tracker
speak with us on the Archivers Slack

Contributing

We welcome your input! If you notice any errors, would like to submit changes, or add any content, you can contribute improvements to this documentation on GitHub: github.com/datatogether/learning.

Cloning this Repo

You can clone a copy of this repository using the following command line:

$ git clone git@github.com:datatogether/learning.git

Installing Dependencies

To install GitBook, you will need Node.js (v4.0.0 or above) on your system and you must be running Windows, Mac OS X, Linux, or Unix.

It is easiest to install gitbook-cli with npm, the Node.js package manager. From your terminal, run the following command:

$ npm install gitbook-cli -g

Additional instructions for setting up and installing GitBook can be found in the GitBook Toolchain Documentation

Running Locally

Once you make changes to the contents, you can preview them by running a local GitBook server:

$ gitbook serve

After starting the server using the command above, visit http://localhost:4000 (or whatever address was indicated by the gitbook serve command) in your web browser.

Deploying

The scripts/ folder has all you need to rebuild the GitBook materials in multiple formats and publish to gh-pages and datatogether.github.io/learning:

$ bash scripts/build_formats.sh
$ bash scripts/publish_gh-pages.sh

You may need to install Calibre's ebook-convert cli tools. For Mac OS X, these can be copied from the Calibre application:

$ ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin

[fill out this section if the repo contains deployable/installable code]

Development

[Step-by-step instructions about how to set up a local dev environment and any dependencies]

Deployment

[Optional section with deployment instructions]

allenpg / learning