Skip to content

Commit

Permalink
completely revamp structure
Browse files Browse the repository at this point in the history
  • Loading branch information
bobheadxi committed Jun 2, 2019
1 parent 0e8f463 commit 16bb46d
Show file tree
Hide file tree
Showing 21 changed files with 222 additions and 195 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -1 +1,2 @@
* @ubclaunchpad/exec @ubclaunchpad/tech-leads
manifesto @ubclaunchpad/exec
56 changes: 0 additions & 56 deletions GettingStarted/README.md

This file was deleted.

111 changes: 0 additions & 111 deletions GettingStarted/Tools.md

This file was deleted.

4 changes: 0 additions & 4 deletions GettingStarted/x/README.md

This file was deleted.

36 changes: 25 additions & 11 deletions README.md
@@ -1,5 +1,7 @@
# Docs

Welcome to the UBC Launch Pad knowledge base!

All Launch Pad-wide documentation lives in this repo. The goal of this
repository is to gather advice, resources, best practices, and more for everyone
to refer to. If you feel any of this documentation is unclear, out of date, or
Expand All @@ -8,22 +10,20 @@ or [pull request](https://github.com/ubclaunchpad/docs/compare)!

## Contents

### 🎉 Getting Started
### 🎉 Manifesto

[Getting Started](GettingStarted/) contains everything new developers need to
get productive at Launch Pad, including introductions to team structure, a list
of the tools we currently use, and administrative details about Launch Pad.
The [Manifesto](manifesto/) outlines what Launch Pad's mission, vision, and how
we are run.

### 📖 Development Bible
### 🧗 Resources

Our [Development Bible](DevelopmentBible/) compiles hard-won advice about the
best way to run (and participate in) a Launch Pad team and build great software.
[Resources](resources/) provides helpful guides, tools, and resources to help
you get started and keep learning.

### 🧗 Exploration
### Project Management

The [Exploration](Exploration/) section has Tech Lead-approved resources for
those that want to explore more complicated topics like operating systems,
programming languages, and machine learning.
The [Project Management](project-management/) pages compile hard-won advice about
the best way to run (and participate in) a Launch Pad team and build great software.

## Other Repos

Expand All @@ -42,3 +42,17 @@ the org, talk to your Tech Lead or one of the Presidents.
* [Tech Leads](https://github.com/ubclaunchpad/tech-leads): A repo for Tech
Lead-specific content, such as meeting notes. Note that this repo is only
visible to Tech Leads.

## Get in Touch

Please feel free to reach out if you have any questions about Launch Pad or the
documentation here:

* Shoot us an email at [team@ubclaunchpad.com](team@ubclaunchpad.com)
* Get in touch via our [Facebook](https://www.facebook.com/ubclaunchpad/) or
[Instagram](https://www.instagram.com/ubclaunchpad/) pages
* [Issues](https://github.com/ubclaunchpad/docs/issues/new) or
[pull requests](https://github.com/ubclaunchpad/docs/compare) are always welcome

If you are a member of Launch Pad, feel free to drop questions for Launch Pad
leadership at [#ask-leadership](https://ubclaunchpad.slack.com/messages/CK935RD3Q/).
7 changes: 7 additions & 0 deletions manifesto/README.md
@@ -0,0 +1,7 @@
# UBC Launch Pad Manifesto

*This section is a work in progress.*

* [Vision](./vision.md)
* [Code of Conduct](./code-of-conduct.md)
* [Administration](./administration.md)
@@ -1,4 +1,4 @@
# Administrivia
# Administration

This document pertains to the administrative side of managing Launch Pad teams,
such as team structure, meeting schedules, the roles of different teams, and
Expand Down
File renamed without changes.
20 changes: 20 additions & 0 deletions manifesto/vision.md
@@ -0,0 +1,20 @@
# Vision

> To be the leading university technology organization to ready our members for
industry and entrepreneurship.

UBC Launch Pad is a student team devoted to building software projects in a
collaborative and professional environment.

Our primary objective is to provide the best space at UBC for students to meet
other tech enthusiasts, build projects in a team setting, and practice
professional development tools and principles.

Our secondary objective is to connect with the UBC and Vancouver tech community
by hosting tech-focused events. Examples include interview workshops, tech
talks, and hackathons. We aim to build public interest in tech at UBC and
provide our members with opportunities to develop soft skills like public
speaking and event planning.

If you're interested in hosting a tech talk or have an event idea, post on
Slack or talk to one of the execs!
13 changes: 4 additions & 9 deletions DevelopmentBible/README.md → project-management/README.md
Expand Up @@ -4,27 +4,22 @@ This page contains best practices for successfully building projects at Launch
Pad. These are guidelines, not strict rules! Teams should adjust these processes
to the way they work. Furthermore, this is a living document and should be
updated to reflect the most current and most productive development processes at
Launch Pad--in particular, open a pull request if there's something you think
Launch Pad - in particular, open a pull request if there's something you think
should be updated or changed!

## 🛶 Git Workflow

A recommended git/GitHub collaborative development workflow is introduced in
[Git Workflow](GitWorkflow.md).

## 📦 Repository Management

Guidelines for how to manage your GitHub repository and enforce coding standards
is in [Repository Management](RepositoryManagement.md). Remember: your
is in [Repository Management](./repositories.md). Remember: your
repository is your main outlet to the outside world - and this outside world
includes potential employers! Make it informative, organized, and pretty!

## 🏃 Sprint Planning

Guidelines for how to plan out a week's work using a Scrum-like methodology can
be found in [Sprint Planning](SprintPlanning.md).
be found in [Sprints](./sprints.md).

## 🔍 Requirements & Scope

Tips for planning out your project's overall scope are available in
[Requirements & Scope](Requirements.md).
[Requirements & Scope](./requirements.md).
File renamed without changes.
@@ -1,4 +1,4 @@
# 🔍 Requirements & Scope
# 🔍 Project Scope

This document outlines advice on how to manage projects requirements and scope.

Expand Down
@@ -1,4 +1,4 @@
# 🏃 Sprint Planning
# 🏃 Sprints

Launch Pad uses agile software development, as is common in industry. In
particular, Launch Pad uses a mixture of the Scrum and Kanban methodologies.
Expand Down
27 changes: 26 additions & 1 deletion GettingStarted/Resources.md → resources/README.md
Expand Up @@ -6,18 +6,37 @@ touch with your tech lead - they can direct you to more resources or to
another Launch Pad member that knows more. And if you want to add even more
resources, feel free to [make a pull request](../CONTRIBUTING.md).

* [Git Workflow](#git-workflow)
* [Programming Languages](#programming-languages)
* [Tools](#tools)
* [Deployment](#deployment)
* [Repo Management](#repo-management)
* [Command Line](#command-line)
* [Front End Development](#front-end-development)
* [Cheatsheets](#cheatsheets)
* [General Learning](#general-learning)
* [Exploration](#exploration)
* [Windows](#windows)

## Git Workflow

A recommended git/GitHub collaborative development workflow is introduced in
[Git Workflow](git-workflow.md).

## Programming Languages

Looking for resources to a specific programming language? Drop by the
[Languages](Languages.md) page!
[Languages](./languages.md) page!

## Tools

Boost your productivity and learn about the tools we use at Launch Pad over in
the [Tools](tools/) pages!

## Deployment

Want to make your project available to the world? Head on over to our
[Deployment](./deployment.md) section!

## Repo Management

Expand Down Expand Up @@ -78,6 +97,12 @@ Looking for resources to a specific programming language? Drop by the
provides a collection of technical things every software developer should
know.

## Exploration

The [Exploration](./exploration.md) section has Tech Lead-approved resources for
those that want to explore more complicated topics like operating systems,
programming languages, and machine learning.

## Windows

* Having trouble with Windows? Try [dual booting Linux](x/Windows.md)!
20 changes: 20 additions & 0 deletions resources/deployment.md
@@ -0,0 +1,20 @@
# Deployment

This page outlines tips, resources, and tools for getting your team's project
deployed and running!

*This section is a work in progress.*

## Inertia

Several Launch Pad projects in the past have utilized our in-house deployment
tool, [Inertia](https://github.com/ubclaunchpad/inertia), to kickstart their
projects.

A comprehensive usage guide is available in the [Inertia documentation](https://inertia.ubclaunchpad.com/).
A good place to start might be to look into leveraging
[Inertia's AWS integration](https://inertia.ubclaunchpad.com/#provisioning-a-remote)
that lets you easily provision a remote for deployment.

Feel free to swing by [#ask-inertia](https://ubclaunchpad.slack.com/messages/CJVF27QUS/)
if you have any questions!
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 16bb46d

Please sign in to comment.