Skip to content

Commit

Permalink
Github->GitHub, pure markdown, more
Browse files Browse the repository at this point in the history 
Spelling corrections, HTML -> markdown conversion, some punctuation changes.
  • Loading branch information
@goldfndr
goldfndr authored Oct 19, 2018
1 parent f3726fa commit 2ebf95a
Showing 1 changed file with 47 additions and 39 deletions.
86 changes: 47 additions & 39 deletions GITHUB_HOSTING/GITHUB_HOSTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,45 +1,53 @@
# Hosting your Gigapixel through Github

Before you can being this process, you will need to have generated Zoomify images. You can learn more about how to make one [here](https://storymap.knightlab.com/gigapixel/).

1. Sign up to create an account on Github. A free account is fine. If you already have an account, you can proceed to the next step.
<br><br>
2. Start a new project either by pressing the “Start a project” button or, if you already have a Github account, clicking on the plus sign in the top right and selecting “New repository.”
<br><br>
<img src="1.png" width="90%"><br>
<br><br>
3. Create your new repository, and give it an identifying name. Make sure your repository is set to public. Check the box to initialize your repository with a README. A repository is just a place for us to store our files. In our case, we'll be uploading our Zoomify images to this repository.
<br><br>
<img src="2.png" width="90%"><br>
<br>
<img src="3.png" width="90%"><br>
# Hosting your Gigapixel through GitHub

Before you can begin this process, you will need to have generated Zoomify images. You can learn more about how to make one [here](https://storymap.knightlab.com/gigapixel/).

1. Sign up to create an account on GitHub. A free account is fine. If you already have an account, sign in.

2. Start a new project either by pressing the “Start a project” button or, if you already have a GitHub account, clicking on the plus sign in the top right and selecting “New repository.”

![](1.png)

3. Create your new repository and give it an identifying name. Make sure your repository is set to public. Check the box to initialize your repository with a README. A repository is just a place for us to store our files. In our case, we'll be uploading our Zoomify images to this repository.

![](2.png)

![](3.png)

*Your newly created repository should look like this, and contain one file named README.md.*
<br><br>
4. If you’re new to Github, download [Github Desktop](https://desktop.github.com). Then go to the “Clone or download” button and click “Open in Desktop.” If you're comfortable using Github through the command line, you can clone the repository like normal, move your Zoomify images to your cloned folder, commit and push, and skip to step 7.
<br><br>
<img src="4.png" width="90%"><br>
*Clicking "Open in Desktop" should automatically launch the Github Desktop application.*
<br><br>

4. If you’re new to GitHub, download [GitHub Desktop](https://desktop.github.com). Then go to the “Clone or download” button and click “Open in Desktop.” If you're comfortable using GitHub through the command line, you can clone the repository like normal, move your Zoomify images to your cloned folder, commit and push, and skip to step 7.

![](4.png)

*Clicking "Open in Desktop" should automatically launch the GitHub Desktop application.*

5. Once you have your project repository cloned, you can right-click the repository name and select “Open in Finder.” This is the folder on your computer where you will place your Zoomify images, and it should already have one file in it: the README we created in step 3. Once you’ve located the folder on your computer, move all the files and folders generated by Zoomify into your repository folder. After you've done so, your folder should look something like this, with a `README.md`, an `ImageProperties.xml` and all your TileGroup folders.
<br><br>
<img src="5.png" width="90%"><br>

![](5.png)

*Move or copy everything from your Zoomify folder to your cloned folder.*
<br><br>
6. Go back to the Github Desktop application. You should now have a tab at the top of your screen that says “X Uncommitted Changes.” In the “Summary” field, type a descriptive message of your content. Then click “Commit and Sync master” to upload your files (Note: the button may be disabled for a while after clicking “Commit and Sync master” if you have a lot of images to upload. This is normal).
<br><br>
<img src="6.png" width="90%"><br>
*Your Github Desktop application should display all the files you moved into cloned folder.*<br><br>
<img src="7.png" width="90%"><br>
*After clicking "Commit and Sync master," you should be able to see all your Zoomify files in your Github repository.*
<br><br>
7. Once your sync has completed, navigate to the settings tab and scroll down to the “Github Pages” section. Create a page for your project by selecting the source branch (master) and clicking “Save.” After the page refreshes, scroll back down to the Github Pages section and you will find the url you can use to create your Gigapixel (Note: clicking on this link directly will take you to an error page saying that Github can’t find what you’re looking for. This is normal.).
<br><br>
<img src="8.png" width="90%"><br>
<br>
<img src="9.png" width="90%"><br>

6. Go back to the GitHub Desktop application. You should now have a tab at the top of your screen that says “X Uncommitted Changes.” In the “Summary” field, type a descriptive message of your content. Then click “Commit and Sync master” to upload your files. (Note: the button may be disabled for a while after clicking “Commit and Sync master” if you have a lot of images to upload. This is normal).

![](6.png)

*Your GitHub Desktop application should display all the files you moved into cloned folder.*

![](7.png)

*After clicking "Commit and Sync master," you should be able to see all your Zoomify files in your GitHub repository.*

7. Once your sync has completed, navigate to the settings tab and scroll down to the “GitHub Pages” section. Create a page for your project by selecting the source branch (master) and clicking “Save.” After the page refreshes, scroll back down to the GitHub Pages section and you will find the url you can use to create your Gigapixel. (Note: clicking on this link directly will take you to an error page saying that GitHub can’t find what you’re looking for. This is normal.)

![](8.png)

![](9.png)

*Copy this link to use as your Zoomify URL.*

You're done! Use the [Storymap authoring tool](https://storymap.knightlab.com/select/) to create your Gigapixel and include your GitHub url.

![](10.png)

You're done! Use the [Storymap authoring tool](https://storymap.knightlab.com/select/) to create your Gigapixel and include your Github url.
<img src="10.png" width="90%"><br>
*Paste the link you copied from Github into the "Zoomify URL" text box to complete the process.*
*Paste the link you copied from GitHub into the "Zoomify URL" text box to complete the process.*

0 comments on commit 2ebf95a

Please sign in to comment.