Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added instructions for gh-pages deployment #144

Merged
merged 3 commits into from
Jun 13, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ The QMK Configurator allows simple keymap creation and saving via .json keymap f
This project is very much a work in progress. To begin contributing, please refer to the following:

[Issues](https://github.com/qmk/qmk_configurator/issues)
[Development Environment Setup](https://github.com/qmk/qmk_configurator/blob/master/assets/js/development.md)

[Development Environment Setup](https://github.com/qmk/qmk_configurator/blob/master/assets/js/development.md)
[Deploying an instance of the Configurator](https://github.com/qmk/qmk_configurator/blob/master/assets/js/gh-pages_setup.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add 'to github pages' to title

46 changes: 46 additions & 0 deletions assets/js/gh-pages_setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# How to set up a GitHub instance of the QMK Configurator

This document will walk you through deploying an instance of the QMK Configurator via your own repository.

## 1. Fork the qmk/qmk_configurator repository

Go to [qmk/qmk_configurator](https://github.com/qmk/qmk_configurator), and click the `fork` button at top right.

## 2. Create a gh-pages branch

In your git CLI, enter:

git branch gh-pages
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be git checkout gh-pages


This will create a copy of the `gh-pages` branch that is already on the QMK repo.

## 3. Remove the CNAME directory

Remove the `CNAME` directory, which is only for the production version of the Configurator.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, sorry, I forgot to write something here. It's a file, not a directory.


rm CNAME

## 4. Edit the _config.yml file

In the root directory, open the `_config.yml` file in a text editor, and edit it as appropriate:

title: QMK Configurator
email: <github_email> # the email attached to your GitHub account
show_downloads: true
description: QMK for potatoes - an open source configurator for QMK Firmware (only the AVR boards right now)
baseurl: "/qmk_configurator" # DO NOT CHANGE THIS LINE!
# Replace <github_username> on the following three lines with your GitHub username
url: "http://<github_username>.qmk.fm"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's always <github_username>.github.io

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I may have edited this wrongly when I did my initial deployment. I have http://noroadsleft.qmk.fm but I haven't found any unusual behaviour (granted, I haven't really done much with it).

github_username: <github_username>
repository: <github_username>/qmk_configurator
theme: jekyll-theme-minimal

## 5. Deploy your instance

When you're done editing, save the file, commit it to your branch, and push your changes to your GitHub repo.

git add .
git commit -m "initial setup"
git push

Once you've pushed your changes, your instance should be live in about 30 seconds at `https://<github_username>.qmk.fm/qmk_configurator`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/.qmk.fm/github.io/ and I think you have it.