-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathknots.html
222 lines (211 loc) · 12.7 KB
/
knots.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.2/css/bootstrap.min.css" integrity="sha384-Smlep5jCw/wG7hdkwQ/Z5nLIefveQRIY9nfy6xoR1uRYBtpZgI6339F5dgvm/e9B" crossorigin="anonymous">
<title>data.world and KNOTS</title>
<link href="https://fonts.googleapis.com/css?family=Roboto:400,400i,700,700i" rel="stylesheet">
</head>
<body style="color:#333D49;">
<!--jumbotron header-->
<div class="header" style="background:#333D49; max-height:150px;">
<div class="container p-responsive py-6 py-lg-10 text-center" style="color:#fff;">
<img src="dw+knots_light.png" class="mb-3 mb-sm-5 col-6 col-sm-12" style="max-width:550px;">
</div>
</div>
<!--first intro-->
<div class="container align-items-center text-center form-group align-items-center" style="padding-bottom:1em;padding-top:4em;">
<h1 style="font-weight:400"> You've enabled KNOTS, now what?</h1>
<p class="h5" style="font-weight:300"> With KNOTS, you can quickly and easily leverage ETL without complex manual configurations.
</p>
</div>
<!--first section-->
<div class="container" style="padding-bottom:1em;padding-top:2em;">
<div class="row">
<div class="col">
<h2 style="font-weight:400" id="download-knots-docker"> Download KNOTS & Docker.</h2>
<p class="h5" style="font-weight:300">Before you can start replicating your data, you'll need to download and install KNOTS and Docker:</p>
<ol style="list-style-position: inside;">
<li style="padding-bottom:1em; font-weight:300; padding-top:2em;">Download the correct package from the <a href="https://github.com/singer-io/knots/releases/latest" target="_blank">newest releases</a> in the KNOTS repository on GitHub <i>(KNOTS is built on top on Singer.io taps & targets)</i>.
</li>
<div class="alert alert-warning">
On the releases page, scroll down to the <span class="h5"> Download KNOTS </span> portion of the page, where you can quickly download the correct package for your system (.dmg for Mac, .exe for Windows).
</div>
<li style="font-weight:300; padding-bottom:1em;">Download the correct Docker package for your system <i style="font-size:85%">(you will need to create a free Docker account if you don't already have one).</i>
</li>
<div class="container">
<div class="row">
<div class="col">
<button type="button" class="btn btn-primary ml-lg-3" style="margin-bottom:1em;"><a href="https://store.docker.com/editions/community/docker-ce-desktop-mac" style="color:#fff; text-decoration:none;">Download for Mac </a></button>
<button type="button" class="btn btn-primary ml-lg-4" style=" margin-bottom:1em;"><a href="https://store.docker.com/editions/community/docker-ce-desktop-windows" style="color:#fff; text-decoration:none;">Download for Windows</a></button>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col ml-lg-3">
<p style="font-size:80%">
<a href="https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-for-mac" target="_blank">Installation instructions for Mac</a>
</p>
</div>
</div>
<div class="row">
<div class="col ml-lg-3">
<p style="font-size:80%">
<a href="https://docs.docker.com/docker-for-windows/install/" target="_blank">Installation instructions for Windows</a>
</p>
</div>
</div>
</div>
<li style="font-weight:300;">Install KNOTS and Docker on your computer.
</li>
</ol>
</div>
</div>
</div>
<!--second section-->
<div class="container" style="padding-bottom:1em;padding-top:2em;">
<div class="row">
<div class="col">
<h2 style="font-weight:400"> Create your knot.</h2>
<p class="h5" style="font-weight:300"> Now that KNOTS & Docker are installed, you can begin creating your first knot:
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col">
<ol style="list-style-position: inside;">
<li style="padding-bottom:1em; font-weight:300; padding-top:1em;">Open KNOTS & Docker (make sure Docker is open & running before starting your first knot.)
</li>
<div class="alert alert-primary" style="font-size:90%">
When opening KNOTS in Windows, you may receive a popup that states "Windows protected your PC". Click on More info, followed by Run anyway.
</div>
<div class="alert alert-secondary" style="font-size:90%">
<b>
Docker Tips:
</b>
<ul style="list-style-position:inside;">
<li style="padding-bottom:1em; font-weight:300; padding-top:1em;"><b>On Mac:</b> Check the Docker <i>file sharing preferences</i> to make sure <code>Users</code> is a shared directory.
</li>
<li style="font-weight:300; padding-bottom:1em;"><b>On Windows:</b> The first time you set up a tap, Docker will ask to share the C drive. Accept, and enter your password if prompted.
</li>
</ul>
</div>
<li style="padding-bottom:1em; padding-top:1em; font-weight:300;">
Select your tap (the source you want to use to replicate data).
</li >
<div class="container" style="padding-bottom:1em;padding-top:1em;">
<div class="row">
<div class="col-sm-8 ml-lg-4" >
<img src="knots_choose-tap.png" class="img-fluid rounded" style="box-shadow: 3px 3px 45px grey;">
</div>
</div>
</div>
<li style="font-weight:300; padding-bottom:2em; padding-top:2em;">Configure your tap. You'll need to enter the following information:
<ul style="list-style-position: inside;">
<li style="padding-bottom:1em; padding-top:2em; font-weight:300;">
Hostname.
</li>
<div class="alert alert-secondary col-sm-9" style="font-weight:300; font-size:1em;">
<i>If you are running your database locally, enter <code>host.docker.internal</code> instead of <code>localhost</code></i>
</div>
<li style="font-weight:300; padding-bottom:1em;">
Port.
</li>
<div class="alert alert-secondary col-sm-9" style="font-weight:300;">
<i>Most apps have a default port (<b>5432</b> for PostgreSQL, <b>3306</b> for MySQL).</i>
</div>
<li style="padding-bottom:1em; font-weight:300;">
Your database name.
</li>
<li style="padding-bottom:1em; font-weight:300;">
Username & password for your database.
</li>
</ul>
</li>
<div class="col-sm-8 ml-lg-4" >
<img src="knots_config-tap.png" class="img-fluid rounded" style="box-shadow: 3px 3px 45px grey;">
</div>
<li style="font-weight:300; padding-bottom:3em; padding-top:3em;">Select any and all data that you would like to replicate.
</li>
<div class="col-sm-8 ml-lg-4" >
<img src="knots_choose-data.png" class="img-fluid rounded" style="box-shadow: 3px 3px 45px grey;">
</div>
<li style="font-weight:300; padding-bottom:3em; padding-top:3em;">Select data.world as your target.
</li>
<div class="col-sm-8 ml-lg-4" >
<img src="knots_choose-target.png" class="img-fluid rounded" style="box-shadow: 3px 3px 45px grey;">
</div>
<li style="font-weight:300; padding-bottom:2em; padding-top:2em;">Configure the data.world target. You'll need to enter the following information:
<ul style="list-style-position: inside;">
<li style="padding-bottom:1em; padding-top:2em; font-weight:300;">
Dataset URL.
</li>
<div class="alert alert-secondary col-sm-9" style="font-weight:300; font-size:1em;">
<i>Choose <b>Browse</b> to choose from a list of available datasets.</i>
</div>
<li style="padding-bottom:1em; font-weight:300;">
Your API token (from your data.world's <a href="https://data.world/integrations/knots?tab=settings" target="_blank">KNOTS integration page</a>).
</li>
<li style="padding-bottom:2em; font-weight:300;">
Username & password for your database.
</li>
</ul>
<div class="col-sm-8 ml-lg-4" >
<img src="knots_config-target.png" class="img-fluid rounded" style="box-shadow: 3px 3px 45px grey;">
</div>
</li>
<li style="font-weight:300; padding-bottom:1em; padding-top:2em;">Choose a name for your knot, then choose <b>Save & Run. </b>
</li>
<div class="alert alert-warning col-sm-9" style="font-weight:300; font-size:1em;">
While your knot is running, you can cancel and and resume at any time without any loss of progress.
</div>
</ol>
</div>
</div>
</div>
<!--what's next-->
<hr style="margin-top:1em;">
<div class="container" style="padding-bottom:1em; padding-top:1em;">
<div class="row">
<div class="col-sm-8">
<h2 style="font-weight:400; padding-top:1em;"> What next?</h2>
<p class="h5" style="font-weight:300"> Here are a few things you can do with KNOTS and data.world:</p>
<ul style="list-style-position: inside; padding-top:2em;">
<li style="padding-bottom:1em; font-weight:300;">With any saved knot, you can sync new data, sync all data, and edit, export, or delete your knot.
</li>
<li style="padding-bottom:1em; font-weight:300;">Using the <b>Export</b> function, you can set up a job that will update your data automatically on a schedule. <a href="https://github.com/singer-io/knots/blob/master/README.md#run-with-a-scheduler" target="_blank" >Learn more about using a job scheduler here</a>
</li>
</ul>
</div>
</div>
</div>
<!--video-->
<hr style="margin-top:1em;">
<div class="container" style="padding-bottom:1em; padding-top:1em;">
<div class="row">
<div class="col-sm-9">
<h2 style="font-weight:400; padding-top:1em;"> Knots walkthrough video</h2>
<p class="h5" style="font-weight:300"> Watch a short video that will walk you through the process of installing and using KNOTS. <br><span style="font-size:85%; color:grey;"><i>Please note, this walkthrough is shown on MacOS.</i></span></p>
<div class="embed-responsive embed-responsive-16by9" style="margin-top:2em;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/Rd-a2Pwn_LE" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
</div>
</div>
</div>
</div>
<!--footer-->
<div class="jumbotron-fluid text-center align-items-center border-top" style="margin-top:1em; padding-top:3em; padding-bottom: 3em; background-color:#F2F2F2; color:#36454f">
<h4 style="font-weight:300"> Want to see more information on the data.world + KNOTS Integration? <u><a href="https://help.data.world/hc/en-us/articles/360008272614-KNOTS" style="color:#36454f; font-weight:600;" target="_blank">check it out here</a></u>.
</h4>
</div>
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.2/js/bootstrap.min.js" integrity="sha384-o+RDsa0aLu++PJvFqy8fFScvbHFLtbvScb8AjopnFD+iEQ7wo/CG0xlczd+2O/em" crossorigin="anonymous"></script>
</body>
</html>