diff --git a/docs/busses.md b/docs/busses.md index 67181bbb0..cff5516cd 100644 --- a/docs/busses.md +++ b/docs/busses.md @@ -1,7 +1,7 @@ --- id: busses -title: Busses -sidebar_label: Busses +title: Bus Lists +sidebar_label: Bus Lists --- HackathonManager enables you to facilitate bus sign-ups for attendees during the RSVP process. diff --git a/docs/deployment-dokku.md b/docs/deployment-dokku.md index 224e629a6..7f5c1cf04 100644 --- a/docs/deployment-dokku.md +++ b/docs/deployment-dokku.md @@ -7,33 +7,11 @@ title: Dokku Deployment > >If you need a VM, check out [DigitalOcean](https://m.do.co/c/b5ee103e23c3) or [Linode](https://www.linode.com/?r=e90a6fb2a6999fb4ec7b60b1add3e288f97954bf) and the [Dokku docs](http://dokku.viewdocs.io/dokku/) to get started. -## Updating an existing deployment - -If you already have a deployment of HackathonManager on Dokku, follow these steps to update it. - -* If you already have the hackathon-manager repo cloned locally: -```bash -# cd into the directory you have hackathon-manager cloned -cd hackathon-manager -git pull -# Skip to "git push" if you already added the remote -git remote add dokku dokku@your-host.example.com:hm -git push dokku master -``` - -* If you don't have it cloned locally: -```bash -git clone git@github.com:codeRIT/hackathon-manager -cd hackathon-manager -git remote add dokku dokku@your-host.example.com:hm -git push dokku master -``` - ## Setting up a new deployment -Below are steps & notes to deploy HackathonManager on Dokku. +Below are steps & notes to deploy HackathonManager on Dokku. Need to update an existing deployment? -If you have any questions at all, please don't hesitate to reach out to [Stuart](https://github.com/sman591)! This doc is very much a work in progress but we want to keep it as up to date as possible. +If you have any questions at all, please don't hesitate to reach out to the [codeRIT Engineering Team](mailto:engineering@coderit.org)! This doc is very much a work in progress but we want to keep it as up to date as possible. ## Dokku plugins @@ -199,4 +177,4 @@ In order to support groupdate, timezone tables must be created. ```bash mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u $OPENSHIFT_MYSQL_DB_USERNAME -p mysql -``` +``` \ No newline at end of file diff --git a/docs/deployment-heroku.md b/docs/deployment-heroku.md index 4bf3cb200..8382306b7 100644 --- a/docs/deployment-heroku.md +++ b/docs/deployment-heroku.md @@ -7,7 +7,7 @@ Heroku deployment is pretty straightforward thanks to Heroku's one-click deploys Click the button below to start. You'll be prompted to fill out a few questions and environment variables. -**See [Environment Variables](deployment-environment-variables.md) for all required environment variables** +**See [Environment Variables](deployment-environment-variables.md) for all required environment variables and what they do.** [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/codeRIT/hackathon-manager) diff --git a/docs/deployment.md b/docs/deployment.md index 1c5e0430c..0111c8dbf 100755 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -1,6 +1,6 @@ --- id: deployment -title: Deployment +title: Getting Started --- HackathonManager is a standalone web app separate from your regular marketing website/public homepage. @@ -20,13 +20,15 @@ Easiest & quickest way that requires little server knowledge. Recommended if you aren't familiar with running a Linux virtual machine and can spend ~$17/month. +> **Student Developer?** You can get a free [Hobby dyno](https://devcenter.heroku.com/articles/dyno-types) for up two 2 years with the [GitHub Student Developer Pack](https://education.github.com/pack). [More info...](https://www.heroku.com/github-students) + [Get Started with Heroku »](deployment-heroku.md) ## Dokku A free alternative to Heroku, runs on your own virtual machine. -Recommended if you're on a budget and can set up Dokku on a Linux virtual machine, usually $5-10/month. +Recommended if you're on a budget and can set up Dokku on a Linux virtual machine, usually $5-10/month with services like Amazon Web Services, Google Cloud, and others. This method is free if running on premises with an always on virtual machine. [Get Started with Dokku »](deployment-dokku.md) diff --git a/docs/maintenance.md b/docs/maintenance.md new file mode 100644 index 000000000..78e8ada01 --- /dev/null +++ b/docs/maintenance.md @@ -0,0 +1,40 @@ +--- +id: updating-hm +title: Updating HackathonManager +--- + +We made it easy to update HackathonManager while in production. It's important to always keep HackathonManager up-to-date for new features and improvements. + +## Heroku + +If a deployment of HackathonManager already exists on Heroku, follow these steps to update it. + +> Ensure [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) is installed locally and is [authenticated](https://devcenter.heroku.com/articles/heroku-cli#getting-started) with an account permitted to push to the Heroku instance before continuing. + +```bash +# cd into the directory where hackathon-manager is cloned into +cd hackathon-manager +git pull +git push heroku master +``` +## Dokku + +If a deployment of HackathonManager already exists on Dokku, follow these steps to update it. + +* If HackathonManager is **already** cloned locally: +```bash +# cd into the directory where hackathon-manager is cloned into +cd hackathon-manager +git pull +# Skip to "git push" if remote is already added +git remote add dokku dokku@your-host.example.com:hm +git push dokku master +``` + +* If HackathonManager is **not yet** cloned locally: +```bash +git clone git@github.com:codeRIT/hackathon-manager +cd hackathon-manager +git remote add dokku dokku@your-host.example.com:hm +git push dokku master +``` diff --git a/docs/running-a-hackathon.md b/docs/running-a-hackathon.md index f7f409314..ad0d1422b 100755 --- a/docs/running-a-hackathon.md +++ b/docs/running-a-hackathon.md @@ -1,7 +1,7 @@ --- id: running-a-hackathon -title: Running a hackathon with HackathonManager -sidebar_label: Running a hackathon +title: HackathonManager Guides +sidebar_label: Overview --- > HackathonManager is a full-service tool to run your hackathon from start to finish. @@ -9,8 +9,9 @@ sidebar_label: Running a hackathon Guides to get you started: - [Timeline of a hackathon](#timeline) -- [Busses](busses.md) - [Questionnaires](questionnaires.md) +- [Messages](messages.md) +- [Bus Lists](busses.md) - _More to come..._ ## Timeline of a hackathon diff --git a/website/pages/en/index.js b/website/pages/en/index.js index 62a48d7cd..238c698f9 100755 --- a/website/pages/en/index.js +++ b/website/pages/en/index.js @@ -58,7 +58,7 @@ class HomeSplash extends React.Component { - + diff --git a/website/sidebars.json b/website/sidebars.json index 782f15584..f030ac1aa 100755 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -1,14 +1,17 @@ { "docs": { - "HackathonManager": ["running-a-hackathon", "busses", "questionnaires", "messages"], - "API": ["api-setup", "api-usage"], - "Deployment": [ + "Setup": [ "deployment", - "deployment-dokku", "deployment-heroku", + "deployment-dokku", "deployment-okd", "deployment-environment-variables", "customization" - ] + ], + "Maintenance" : [ + "updating-hm" + ], + "Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"], + "Development": ["api"] } } diff --git a/website/siteConfig.js b/website/siteConfig.js index f02004ce4..7052ad0de 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -48,7 +48,7 @@ const siteConfig = { // For no header links in the top nav bar -> headerLinks: [], headerLinks: [ { doc: 'deployment', label: 'Get Started' }, - { doc: 'running-a-hackathon', label: 'Docs' }, + { doc: 'running-a-hackathon', label: 'Guides' }, { href: 'https://github.com/codeRIT/hackathon-manager', label: 'GitHub' }, ],