Skip to content

Commit edc9eca

Browse files
author
Vanessa McBride
authored
Merge pull request #37 from paultheastronomer/master
Added a two 'How to...' articles
2 parents 4c13f0b + 3bf2c26 commit edc9eca

6 files changed

Lines changed: 80 additions & 311 deletions

File tree

How_the_toolkit_works.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
How the toolkit works
2+
===================
3+
4+
<p align="center"><img src="https://raw.githubusercontent.com/astro4dev/OAD-Data-Science-Toolkit/master/img/DST_logo_250px.png" alt="DST Logo"/></p>
5+
6+
## Step 1 - Adding toolkit content
7+
The toolkit content is stored on the github servers under the <a href="https://github.com/astro4dev/OAD-Data-Science-Toolkit" target="_blank">OAD-Data-Science-Toolkit</a> repository. Content is added by individual contributors by first cloning the repository, making the changes, then creating a pull request. The astro4dev data science working group are automatically informed about the new pull request. The request is then verified before it is added to the main astro4dev repository.
8+
9+
## Step 2 - Adding the content to the database
10+
11+
Once the content has been uploaded to github it has to be added to the MySQL database. This is done by a member of the astro4dev data science working group. The database is composed of many tables which can be dividied into two groups.
12+
13+
- Content Tables
14+
- Relational Tables
15+
16+
### The content tables
17+
The content tables have one word names, e.g. _skills_.

How_to_upload_content.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
How to upload content
2+
===================
3+
4+
<p align="center"><img src="https://raw.githubusercontent.com/astro4dev/OAD-Data-Science-Toolkit/master/img/DST_logo_250px.png" alt="DST Logo"/></p>
5+
6+
## Get a GitHub account
7+
8+
It's required if you want to submit content to the toolkit which is hosted on GitHub. Get an account <a href="https://github.com/" target="_blank">here</a>.
9+
10+
## Install git on your computer
11+
To use Git on the command line, you'll need to download, install, and configure Git on your computer.
12+
13+
On Ubuntu
14+
```sh
15+
sudo apt-get install git
16+
```
17+
18+
There is also a GUI interface known as the
19+
<a href="https://desktop.github.com/" target="_blank">Desktop version</a> which is available for Windows and for Mac OSX.
20+
21+
## Fork a repository
22+
<a href="https://help.github.com/articles/fork-a-repo/" target="_blank">Instructions on GitHub</a>
23+
24+
## Syncing a fork
25+
If you have previously forked the repository, but it is now 'out of date' you may wish to bring your fork up to date with the main repository. You can find instructions on how to sync a fork <a href="https://help.github.com/articles/syncing-a-fork/" target="_blank">here</a>.
26+
27+
## Making changes
28+
29+
Download all the latest changes to your local repository
30+
```sh
31+
git pull
32+
```
33+
34+
Once you have made changes locally you can get an overview of the files you've alterned (relative to your online repository) by typing:
35+
```sh
36+
git status
37+
```
38+
Red coloured files means they have not been added. Green means they have.
39+
40+
To push a file to your repository clone on github type in any directory (within the
41+
OAD-Data-Science-Toolkit folder):
42+
```sh
43+
git add [name_of_file]
44+
```
45+
46+
You then have to commit it (basically prepare it to be uploaded) by adding a comment describing what you did:
47+
```sh
48+
git commit -m 'I removed the bug causing...'
49+
```
50+
51+
Finally push it to your online clone of the repository by typing:
52+
```sh
53+
git push
54+
```
55+
56+
## Opening pull requests
57+
If you are hoping to contribute back to the original repository, you can send a request to the original author to pull your fork into their repository by submitting a <a href="https://help.github.com/articles/about-pull-requests/" target="_blank">pull request</a>.
58+
59+
60+
61+
62+

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ For more information on the OAD including current projects and how you can contr
4242

4343
## License
4444
<p><a href="http://www.gnu.org/licenses/gpl-3.0.html" target="_blank"><img src="https://www.gnu.org/graphics/gplv3-127x51.png"></a></p>
45-
Licensed under the <a href="http://www.gnu.org/licenses/gpl-3.0.html" target="_blank">GPLv3</a>.
45+
Licensed under the <a href="http://www.gnu.org/licenses/gpl-3.0.html" target="_blank">GPLv3</a>.

Teaching Materials/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,3 @@ Teaching Materials
22
===================
33

44
This part of the toolkit provides teaching materials which most of them utilise astronomy examples to teach data science techniques. You are welcome to use any of the materials as you see fit (in accorance with the <a href="https://www.gnu.org/copyleft/gpl.html" target="_blank">GPLv3 licence</a>), we ask that you give credit to the creator of the material.
5-
6-
For an overview of the teaching materials have a look at our <a href="https://rawgit.com/astro4dev/OAD-Data-Science-Toolkit/master/Teaching%20Materials/overview.html" target="_blank">Data Science Toolkit Map</a>.

Teaching Materials/flare.json

Lines changed: 0 additions & 100 deletions
This file was deleted.

0 commit comments

Comments
 (0)