Skip to content

Commit a062140

Browse files
cbaudouinjrcbaudouinjr
authored
feat(docs): Initial documentation for 2.0 (#291)
* feat(docs): Initial documentation for 2.0 * refactor: Updates maintenance.md for verbage changes * refactor: Refactors structure of navigation
1 parent 79831f6 commit a062140

File tree

9 files changed

+64
-40
lines changed

9 files changed

+64
-40
lines changed

‎docs/busses.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: busses
3-
title: Busses
4-
sidebar_label: Busses
3+
title: Bus Lists
4+
sidebar_label: Bus Lists
55
---
66

77
HackathonManager enables you to facilitate bus sign-ups for attendees during the RSVP process.

‎docs/deployment-dokku.md‎

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,11 @@ title: Dokku Deployment
77
>
88
>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.
99
10-
## Updating an existing deployment
11-
12-
If you already have a deployment of HackathonManager on Dokku, follow these steps to update it.
13-
14-
* If you already have the hackathon-manager repo cloned locally:
15-
```bash
16-
# cd into the directory you have hackathon-manager cloned
17-
cd hackathon-manager
18-
git pull
19-
# Skip to "git push" if you already added the remote
20-
git remote add dokku dokku@your-host.example.com:hm
21-
git push dokku master
22-
```
23-
24-
* If you don't have it cloned locally:
25-
```bash
26-
git clone git@github.com:codeRIT/hackathon-manager
27-
cd hackathon-manager
28-
git remote add dokku dokku@your-host.example.com:hm
29-
git push dokku master
30-
```
31-
3210
## Setting up a new deployment
3311

34-
Below are steps & notes to deploy HackathonManager on Dokku.
12+
Below are steps & notes to deploy HackathonManager on Dokku. Need to update an existing deployment?
3513

36-
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.
14+
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.
3715

3816
## Dokku plugins
3917

@@ -199,4 +177,4 @@ In order to support groupdate, timezone tables must be created.
199177

200178
```bash
201179
mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u $OPENSHIFT_MYSQL_DB_USERNAME -p mysql
202-
```
180+
```

‎docs/deployment-heroku.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Heroku deployment is pretty straightforward thanks to Heroku's one-click deploys
77

88
Click the button below to start. You'll be prompted to fill out a few questions and environment variables.
99

10-
**See [Environment Variables](deployment-environment-variables.md) for all required environment variables**
10+
**See [Environment Variables](deployment-environment-variables.md) for all required environment variables and what they do.**
1111

1212
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/codeRIT/hackathon-manager)
1313

‎docs/deployment.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: deployment
3-
title: Deployment
3+
title: Getting Started
44
---
55

66
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.
2020

2121
Recommended if you aren't familiar with running a Linux virtual machine and can spend ~$17/month.
2222

23+
> **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)
24+
2325
[Get Started with Heroku »](deployment-heroku.md)
2426

2527
## Dokku
2628

2729
A free alternative to Heroku, runs on your own virtual machine.
2830

29-
Recommended if you're on a budget and can set up Dokku on a Linux virtual machine, usually $5-10/month.
31+
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.
3032

3133
[Get Started with Dokku »](deployment-dokku.md)
3234

‎docs/maintenance.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: updating-hm
3+
title: Updating HackathonManager
4+
---
5+
6+
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.
7+
8+
## Heroku
9+
10+
If a deployment of HackathonManager already exists on Heroku, follow these steps to update it.
11+
12+
> 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.
13+
14+
```bash
15+
# cd into the directory where hackathon-manager is cloned into
16+
cd hackathon-manager
17+
git pull
18+
git push heroku master
19+
```
20+
## Dokku
21+
22+
If a deployment of HackathonManager already exists on Dokku, follow these steps to update it.
23+
24+
* If HackathonManager is **already** cloned locally:
25+
```bash
26+
# cd into the directory where hackathon-manager is cloned into
27+
cd hackathon-manager
28+
git pull
29+
# Skip to "git push" if remote is already added
30+
git remote add dokku dokku@your-host.example.com:hm
31+
git push dokku master
32+
```
33+
34+
* If HackathonManager is **not yet** cloned locally:
35+
```bash
36+
git clone git@github.com:codeRIT/hackathon-manager
37+
cd hackathon-manager
38+
git remote add dokku dokku@your-host.example.com:hm
39+
git push dokku master
40+
```

‎docs/running-a-hackathon.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
22
id: running-a-hackathon
3-
title: Running a hackathon with HackathonManager
4-
sidebar_label: Running a hackathon
3+
title: HackathonManager Guides
4+
sidebar_label: Overview
55
---
66

77
> HackathonManager is a full-service tool to run your hackathon from start to finish.
88
99
Guides to get you started:
1010

1111
- [Timeline of a hackathon](#timeline)
12-
- [Busses](busses.md)
1312
- [Questionnaires](questionnaires.md)
13+
- [Messages](messages.md)
14+
- [Bus Lists](busses.md)
1415
- _More to come..._
1516

1617
## Timeline of a hackathon

‎website/pages/en/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class HomeSplash extends React.Component {
5858
<ProjectTitle siteConfig={siteConfig} />
5959
<PromoSection>
6060
<Button href={docUrl('deployment.html')}>Get Started</Button>
61-
<Button href={docUrl('running-a-hackathon.html')}>Docs</Button>
61+
<Button href={docUrl('running-a-hackathon.html')}>Guides</Button>
6262
<Button href="https://github.com/codeRIT/hackathon-manager">
6363
GitHub
6464
</Button>

‎website/sidebars.json‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
{
22
"docs": {
3-
"HackathonManager": ["running-a-hackathon", "busses", "questionnaires", "messages"],
4-
"API": ["api-setup", "api-usage"],
5-
"Deployment": [
3+
"Setup": [
64
"deployment",
7-
"deployment-dokku",
85
"deployment-heroku",
6+
"deployment-dokku",
97
"deployment-okd",
108
"deployment-environment-variables",
119
"customization"
12-
]
10+
],
11+
"Maintenance" : [
12+
"updating-hm"
13+
],
14+
"Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"],
15+
"Development": ["api"]
1316
}
1417
}

‎website/siteConfig.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const siteConfig = {
4848
// For no header links in the top nav bar -> headerLinks: [],
4949
headerLinks: [
5050
{ doc: 'deployment', label: 'Get Started' },
51-
{ doc: 'running-a-hackathon', label: 'Docs' },
51+
{ doc: 'running-a-hackathon', label: 'Guides' },
5252
{ href: 'https://github.com/codeRIT/hackathon-manager', label: 'GitHub' },
5353
],
5454

0 commit comments

Comments
 (0)