From f23c1cbeb17573b72f5135a12109b01cc31666d6 Mon Sep 17 00:00:00 2001 From: Aral Balkan Date: Wed, 6 Jun 2018 20:09:47 +0100 Subject: [PATCH 1/6] Use same keyboard shortcut format both times MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit … and ensure consistent terminal naming. --- guide/02-link.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guide/02-link.html b/guide/02-link.html index 74e4919..277eb81 100644 --- a/guide/02-link.html +++ b/guide/02-link.html @@ -26,14 +26,14 @@

dat share

Behind the scenes dat created a new hidden folder called .dat in your test folder. The appearance of the .dat folder means that everything in this directory can now be versioned with Dat.

As long as the dat share process stays open and running the data will be available via the global Dat decentralized network to anyone who has that link. The link is secret and unguessable. Only people who you share the link with will be able to access your dat.

Downloading

-

First, copy the dat link from the source terminal. Windows users beware - please right-click to copy, as cntrl-C will quit dat and dat needs to keep running.

+

First, copy the dat link from the source terminal. Windows users beware - please right-click to copy, as control-C will quit dat and dat needs to keep running.

If you are doing this tutorial using a single computer, open up a second terminal window, we will refer to this second one as the destination terminal. The first one is the source terminal.

If you are doing this tutorial with a second computer, then use the second computer as the destination. Find a way to send them the dat link (email, text message).

On the destination terminal: Move to a directory where you'd like to add these files. To download the files from the source, type dat clone followed by the link dat://, and a folder name like try-dat.

The full command should look like this:

dat clone dat://replace-with-your-dat-link-here try-dat

The files will be downloaded to the destination, to the current working directory, into a folder called try-dat. Take a minute now to check that the files on your destination match the files from the source.

-

Lastly, on the source, type control-C to stop running dat. You should now be back to the command prompt on both terminals.

+

Lastly, on the source terminal, type control-C to stop running dat. You should now be back to the command prompt on both terminals.

OK, next! » From d53144bd154cf4b3a0a3bd0ddce0bd8306743644 Mon Sep 17 00:00:00 2001 From: Aral Balkan Date: Wed, 6 Jun 2018 20:12:32 +0100 Subject: [PATCH 2/6] Consistent terminal naming in 03-modify.html --- guide/03-modify.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/03-modify.html b/guide/03-modify.html index 55511c2..4e8f19c 100644 --- a/guide/03-modify.html +++ b/guide/03-modify.html @@ -14,7 +14,7 @@

table of contents

Editing & sharing data

Now you have a copy of the files on your destination a folder called try-dat! But what happens if the contents of the files change? Let's find out.

-

On the source create a new file called welcome.txt and open it in your favorite text editor app (such as TextEdit or Sublime Text). Make some changes to the text in the file. Once you've edited it, save the file. The file on the source will no longer match the one on the destination. To rectify this and sync the new changes to the destination copy, run dat share again on the source.

+

On the source terminal, create a new file called welcome.txt and open it in your favorite text editor app (such as TextEdit or Sublime Text). Make some changes to the text in the file. Once you've edited it, save the file. The file on the source will no longer match the one on the destination. To rectify this and sync the new changes to the destination copy, run dat share again on the source.

Type the following in the source terminal:

$ dat share

This will create a link, that looks like dat://.... Your output in the source terminal will look something like this:

From 66eb6950317de6fe2c9b20e53ad3efdcf7a185ac Mon Sep 17 00:00:00 2001 From: Aral Balkan Date: Wed, 6 Jun 2018 20:14:00 +0100 Subject: [PATCH 3/6] Fix minor typo in 04-live.html --- guide/04-live.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/04-live.html b/guide/04-live.html index f118fde..c3858e3 100644 --- a/guide/04-live.html +++ b/guide/04-live.html @@ -17,7 +17,7 @@

Live syncing data

Notice that your source terminal window says:

dat synced, waiting for updates.

What happens if you make changes to the source file while your destination is watching? On the source side, edit the welcome.txt rapidly, saving after each edit in your text editor program.

-

Watch what happens in your destionation terminal window as you save.

+

Watch what happens in your destination terminal window as you save.

Since this is a tiny text time, the updates will download extremely fast. Your source terminal window will look something like this:

1 connection | Download 445 KB/s Upload 0 B/s
 

From 5ae3a2c162640060cdcf8ec4ce17a196c0e9f658 Mon Sep 17 00:00:00 2001
From: Aral Balkan 
Date: Wed, 6 Jun 2018 20:16:52 +0100
Subject: [PATCH 4/6] =?UTF-8?q?Make=20sure=20of=20=E2=80=9Cterminal?=
 =?UTF-8?q?=E2=80=9D=20consistent=20in=2001-install.html?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

(In 02-link.html, when referring to a generic terminal, the term “the terminal” is used without any boldfacing. I’m sticking to this in these commits.)
---
 guide/01-install.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/guide/01-install.html b/guide/01-install.html
index d5c6faa..9226d84 100644
--- a/guide/01-install.html
+++ b/guide/01-install.html
@@ -20,7 +20,7 @@ 
Installation

 
If you run into problems, you can view more detailed installation instructions here.

 
You'll also need a Terminal application on your local computer. If you're using Windows, you should use the Git Shell app as your terminal. It is installed with GitHub Desktop. In Mac and Linux you can use the app Terminal, which is already on your computer.

 
If you've never used the command line before, check out Command Line Bootcamp to get comfortable navigating your computer via the command line. 

-
Once you have downloaded npm, install dat on your local machine. Type the following in your local terminal:

+
Once you have downloaded npm, install dat on your local machine. Type the following in your terminal:

 
npm install -g dat
 
This means that dat is now installed on your system:

 
$ dat

From 03e90861a48164f5c2114102ff2377a4d03996ea Mon Sep 17 00:00:00 2001
From: Aral Balkan 
Date: Wed, 6 Jun 2018 20:19:43 +0100
Subject: [PATCH 5/6] =?UTF-8?q?Consistently=20boldface=20=E2=80=9Csource?=
 =?UTF-8?q?=E2=80=9D=20in=20=E2=80=9Csource=20terminal=E2=80=9D?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 guide/02-link.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/guide/02-link.html b/guide/02-link.html
index 277eb81..fadc4b1 100644
--- a/guide/02-link.html
+++ b/guide/02-link.html
@@ -26,7 +26,7 @@ 
dat share

 
Behind the scenes dat created a new hidden folder called .dat in your test folder. The appearance of the .dat folder means that everything in this directory can now be versioned with Dat. 

 
As long as the dat share process stays open and running the data will be available via the global Dat decentralized network to anyone who has that link. The link is secret and unguessable. Only people who you share the link with will be able to access your dat.

 
Downloading

-
First, copy the dat link from the source terminal. Windows users beware - please right-click to copy, as control-C will quit dat and dat needs to keep running.

+
First, copy the dat link from the source terminal. Windows users beware - please right-click to copy, as control-C will quit dat and dat needs to keep running.

 
If you are doing this tutorial using a single computer, open up a second terminal window, we will refer to this second one as the destination terminal. The first one is the source terminal.

 
If you are doing this tutorial with a second computer, then use the second computer as the destination. Find a way to send them the dat link (email, text message).

 
On the destination terminal: Move to a directory where you'd like to add these files. To download the files from the source, type dat clone followed by the link dat://, and a folder name like try-dat. 


From 954a9505326bd96e43f24320493438d2508e1797 Mon Sep 17 00:00:00 2001
From: Aral Balkan 
Date: Wed, 6 Jun 2018 20:24:44 +0100
Subject: [PATCH 6/6] =?UTF-8?q?Use=20=E2=80=9Cterminal=E2=80=9D=20consiste?=
 =?UTF-8?q?ntly=20in=2006-dat-=E2=80=A6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 guide/05-website.html         | 6 +++---
 guide/06-dat-git-partial.html | 8 ++++----
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/guide/05-website.html b/guide/05-website.html
index ee42f30..2bf696d 100644
--- a/guide/05-website.html
+++ b/guide/05-website.html
@@ -15,9 +15,9 @@
       
Hosting a website

 
We've covered sharing, syncing, and live syncing of data. But what about sharing via the web? We can create a Dat link that can be viewed in any browser. Dat has an http server that can be turned on by adding --http$PORT_XX, where XX is specific to the server port. 

 
To share your data via the web, create a file called index.html using the command touch. 
-Type the following into the virtual terminal: 

+Type the following into the terminal: 

 
touch index.html

-
You will see a new file, index.html, has been added to the directory on the virtual server. 

+
You will see a new file, index.html, has been added to the directory. 

 
Let's make it fun! Use the test editor in the browser to add to the new index.html. Edit it and add some stuff in your html. Here's a silly template to get you started. 

 
<!DOCTYPE html>
 <html>
@@ -33,7 +33,7 @@ 
Hosting a website

   <img id="rickroll" src="https://media.giphy.com/media/13tTN4ccM3R6us/giphy.gif"/>  
 </body>
 </html>
-
To share this, type the following in the source terminal:

+

To share this, type the following in the terminal:

dat share --http=8080

Check out your new website at http://localhost:8080!

When you modify file, the site will update when you refresh the browser window. Pretty cool, huh?

diff --git a/guide/06-dat-git-partial.html b/guide/06-dat-git-partial.html index f1b7eac..1e6f5b3 100644 --- a/guide/06-dat-git-partial.html +++ b/guide/06-dat-git-partial.html @@ -15,13 +15,13 @@

Downloading a partial dataset from git

Here's an example of hosting code on Github that includes a link to a Dat dataset. This Github repo contains a dat.json file, which contains the Dat link (dat://...) for the dataset as well as other metadata about these data.

The author has included a .datdownload file which specifies which files users will download by default. Without this, all files would be downloaded upon dat cloning this repository. You can imagine a scenario where a larger dataset is availble, but only segments of it are required to reproduce an analysis. Or a dataset that won't fit in git, but fits in dat. Because this author has a dat.json file in their git repository, you don't need to work with their Dat link. In this exercise, you will clone the repository with git and then access the data with dat.

-

To clone the repository to your local machine using git, type the following in your local terminal:

+

To clone the repository to your local machine using git, type the following in your terminal:

git clone https://github.com/joehand/dat-git-example.git
-

Now you have a copy of dat-git-example that includes text and code files, but none of the data files. Check the index.html to see that the pictures are missing by typing the following in your local terminal:

+

Now you have a copy of dat-git-example that includes text and code files, but none of the data files. Check the index.html to see that the pictures are missing by typing the following in your terminal:

open index.html
-

To get the data, run dat clone --empty to fetch the .dat metadata (but none of the files). Type the following in your source terminal:

+

To get the data, run dat clone --empty to fetch the .dat metadata (but none of the files). Type the following in your terminal: 

dat clone ./dat-git-example --empty
-

Then sync to get the files, specified by the .datdownload, type the following in your source terminal:

+

Then sync to get the files, specified by the .datdownload, type the following in your terminal:

dat sync ./dat-git-example

You should now have downloaded both the code (index.html) and the data files that were specificed by the .datdownload file.