-
Notifications
You must be signed in to change notification settings - Fork 1
/
github-setup.html
175 lines (141 loc) · 7.96 KB
/
github-setup.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Setting up with Github — GGD documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/style.css" />
<link rel="stylesheet" type="text/css" href="_static/font-awesome-4.7.0/css/font-awesome.min.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contributing a ggd recipe" href="contribute-recipe.html" />
<link rel="prev" title="Contribute" href="contribute.html" />
<link href="https://fonts.googleapis.com/css?family=Lato|Raleway" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Inconsolata" rel="stylesheet">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="_static/ms-icon-144x144.png">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.6/css/selectize.bootstrap3.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.3.1/css/bootstrap.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/datatables/1.10.21/js/jquery.dataTables.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.6/js/standalone/selectize.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.3.1/js/bootstrap.bundle.min.js"></script>
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/logo/GoGetData_name_logo.png" alt="Logo"/>
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">GGD Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-ggd.html">Using GGD</a></li>
<li class="toctree-l1"><a class="reference internal" href="GGD-CLI.html">GGD Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="meta-recipes.html">GGD meta-recipes</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="contribute.html">Contribute</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Setting up with Github</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html">Contributing a ggd recipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html">Creating a ggd meta-recipe</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="private_recipes.html">Private Recipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="workflows.html">Using GGD in Workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes.html">Available Data Packages</a></li>
</ul>
<ul>
<li class="toctree-l1"><a href="https://github.com/gogetdata/ggd-recipes">ggd-recipes @ Github</a></li>
<li class="toctree-l1"><a href="https://github.com/gogetdata/ggd-cli">ggd-cli @ Github</a></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="setting-up-with-github">
<span id="setup-github"></span><h1>Setting up with Github<a class="headerlink" href="#setting-up-with-github" title="Permalink to this headline">¶</a></h1>
<p>[<a class="reference internal" href="index.html#home-page"><span class="std std-ref">Click here to return to the home page</span></a>]</p>
<p>A github account is required in order to contribute a data package to ggd. If you do not have a
github account it is easy to create one. (Note: Your github account does not need to be connected
to ggd in order to work)</p>
<ul>
<li><p>Go to <a class="reference external" href="https://github.com/">github.com</a> and sign up for an account. (Accounts are free)</p></li>
<li><p>Once you have an account you will need to fork the <a class="reference external" href="https://github.com/gogetdata/ggd-recipes">ggd-recipes</a>
github repo. This repository is where the ggd data recipes are collected.</p>
<ul class="simple">
<li><dl class="simple">
<dt>In the top right hand corner of the <a class="reference external" href="https://github.com/gogetdata/ggd-recipes">ggd-recipes</a> page you will</dt><dd><p>see a button called <strong>fork</strong>. When you have pressed the button it will ask you where to put the fork. Select
your github account.</p>
</dd>
</dl>
</li>
<li><p><strong>ggd-recipes</strong> will now be a repository attached to your account. (github.com/<github username>/ggd-recipes)</p></li>
</ul>
</li>
<li><p>You will then need to clone the forked ggd-recipes repo to the machine that you are working on.</p>
<ul>
<li><p>On you machine navigate to a directory were you want to download the forked ggd-recipes repo.</p></li>
<li><p><strong>NOTE:</strong> <cite>git</cite> is a required software package. If you do not have it downloaded on your system run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ conda install -c anaconda git
</pre></div>
</div>
</li>
<li><dl class="simple">
<dt><strong>NOTE:</strong> conda is required as well. If you do not have conda installed on your system see <a class="reference internal" href="using-ggd.html#using-ggd"><span class="std std-ref">Using GGD</span></a></dt><dd><p>to install conda and the required software packages on your system. You can then return to this page and continue.</p>
</dd>
</dl>
</li>
</ul>
</li>
<li><p>Clone the forked repository to the current location on your machine.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre"><USERNAME></span></code> is your github account username. This is where the ggd-recipes repo was forked.</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/<USERNAME>/ggd-recipes.git
</pre></div>
</div>
</li>
<li><p>Move into the ggd-recipes directory:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd ggd-recipes/
</pre></div>
</div>
</li>
<li><p>Add the original ggd-recipes repo as an upstream remote repo to the one just added to your machine. This
will make it easier to update your forked repo with the original, upstream repository.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git remote add upstream https://github.com/gogetdata/ggd-recipes.git
</pre></div>
</div>
</li>
</ul>
<p>You have now set up a forked ggd-recipes repository on your machine, which you will use to add data packages to ggd.</p>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016-2021, The GoGetData team.
|
<a href="_sources/github-setup.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>