diff --git a/docs/about/index.md b/docs/about/index.md index 9312d18..21af5ce 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -4,14 +4,39 @@ title: About SIGGD # About SIGGD -[TODO: Write a short description of SIGGD.] +  Founded in Fall 2011, Purdue ACM's Special Interest Group on +Game Development is a multi-disciplinary group of Purdue University +students that creates a new game each school year. As part of the +Association for Computing Machinery Purdue chapter, we are the first +SIGGD of ACM National. Our goal is to develop creative and interesting +games. In addition, we host a game jam (game development hackathon) each +semester where groups come together either online or in-person to create +a video game prototype in 48 hours. -[TODO: Add meeting information.] +  We primarily communicate through our Discord Server, so if +you are interested in joining the club be sure to join that to get started! -[TODO: Add what the club does.] +--- + +# Meeting Info + +  We meet M/W/F at 7:30PM in LWSN B155. Attendance is not +required, but it's more fun to show up! + +--- + +# What We Do + +  Every year we come together to conceptualize and create a +new game. Joining in the middle of the year is perfectly okay; there is +no need to worry about falling behind! + +--- + +# Links | Platform | Link | |----------|------| | GitHub | [github.com/PurdueSIGGD](https://github.com/PurdueSIGGD) | | Discord | [SIGGD](https://discord.gg/nKdj4bTjNs) | -| Instagram | [TODO: Add link] | +| Instagram | [instagram.com/purduesiggd](https://www.instagram.com/purduesiggd) | diff --git a/docs/tutorials/story/story-design-doc.md b/docs/tutorials/story/story-design-doc.md index 10e6361..4b1b354 100644 --- a/docs/tutorials/story/story-design-doc.md +++ b/docs/tutorials/story/story-design-doc.md @@ -4,10 +4,7 @@ title: Story Design Doc # Story Design Doc -WIP +!!! abstract "What's in this article" + Something very cool will be here... eventually --- - -!!! example "No tutorials yet — be the first!" - Use the [Tutorial Template](../../contributing/templates/tutorial-template.md) - and follow the [Contributing Guide](../../contributing/index.md). diff --git a/docs/tutorials/story/story-tasks.md b/docs/tutorials/story/story-tasks.md index 7e6e700..40645b7 100644 --- a/docs/tutorials/story/story-tasks.md +++ b/docs/tutorials/story/story-tasks.md @@ -4,10 +4,7 @@ title: Story Team Tasks # Story Team Tasks -WIP +!!! abstract "What's in this article" + Something very cool will be here... eventually --- - -!!! example "No tutorials yet — be the first!" - Use the [Tutorial Template](../../contributing/templates/tutorial-template.md) - and follow the [Contributing Guide](../../contributing/index.md). diff --git a/docs/tutorials/story/story-team-onboarding.md b/docs/tutorials/story/story-team-onboarding.md index edd5ae5..a16acaf 100644 --- a/docs/tutorials/story/story-team-onboarding.md +++ b/docs/tutorials/story/story-team-onboarding.md @@ -4,10 +4,51 @@ title: Story Team Onboarding # Story Team Onboarding -WIP +!!! abstract "What's in this article" + - Brief introduction + - Design document + - Task list --- -!!! example "No tutorials yet — be the first!" - Use the [Tutorial Template](../../contributing/templates/tutorial-template.md) - and follow the [Contributing Guide](../../contributing/index.md). +# Introduction + +  Hello new story person! My name is Derek Harris, and I’m the +story lead for SIGGD this school year. I’ll keep this fairly short so I +hope you read through everything, there will be a quiz (hahaha so original). +So first let me say welcome to SIGGD, and welcome to the Story Team. If you +have any questions on the content of this article or about anything in +general, please feel free to ask me in person or over discord. Or email +I guess. After reading this you should absolutely read through the [Story +Team Standards](./story-team-standards.md) article, as well as the other articles, but that one’s the +most important. + +--- + +# Story Design Document + +  So obviously the most important thing with working on the story +is to know what the story is. The best resource for learning about the story +will be the [Story Design Document](./story-design-doc.md). The linked article will further explain +what that is. However, the document will probably not have everything you +need to work on specific parts of the story, so I will also have you talk to +one of the other members of Story or myself depending on what’s going on +during the first meeting you attend. + +--- + +# Task List + +  Once you know the story you can immediately be put to work, hooray! +There is a convenient [Task List](./story-tasks.md) that we will be using throughout the year. All +of these tasks should require clarification but it could still be nice to +familiarize yourself with the task organization. + +--- + +# Fly My Birdies + +  I can’t wait to see you in the meetings! Once again feel free to +reach out to me with any questions. Now go read the [Story Team Standards](./story-team-standards.md)! + +--- diff --git a/docs/tutorials/story/story-team-standards.md b/docs/tutorials/story/story-team-standards.md index 63925ac..6db1bf7 100644 --- a/docs/tutorials/story/story-team-standards.md +++ b/docs/tutorials/story/story-team-standards.md @@ -9,6 +9,16 @@ article if you have joined at any point after the first few weeks or so (probabl 25).If you’re joining before then, I should be doing onboarding during the early meetings once it’s necessary so look forward to that. +!!! abstract "What's in this article" + - Story Lead introduction + - Team dynamic + - Support opportunities + - Red, Yellow, and Green Zones + +--- + +# Lead Introduction/Team Dynamic +   I’m Derek Harris, a sophomore in Computer Science who, by luck (good or bad, you decide) would have it, is the story lead for this year. I’m not normally this formal but I feel it’s important to very quickly let you guys know who I am, as I hope you will do for each other. SIGGD @@ -20,6 +30,10 @@ going to avoid ever directly assigning them as much as possible. We should all b needs to be done to arrive at a finished story, and choosing to work on the tasks we want. Essentially I just want a sense of collaboration over simple labor. +--- + +# Support +   However, my ideals may not always be true to what will happen or is happening. Hopefully I will recognize this and any other issues to be dealt with, but this will realistically not always be the case. So I have the first, and hopefully only, assignment for you guys. Pretty pretty please @@ -28,6 +42,10 @@ sticking to my proposed structure for the team, tell me! If there is something h team that is making you uncomfortable, tell me! If you have any questions, tell me!! My only real “job” as story lead is to support you guys and I hope you take full advantage of that. +--- + +# Red, Yellow, and Green Zones +   Now for some information relating to work throughout the year. I want to have story team collaborate with other teams quite a bit, which means you guys will not be meeting exclusively with the rest of the story team and I often times. Therefore this collaboration will require a more @@ -35,11 +53,23 @@ distinct structure to the story details we discuss. I’m currently running with Green zones for story details. Green zone means we have discussed that portion of the story and know generally what direction we want to go in, but specifics haven’t been completely decided. When you’re out amongst the other groups, decisions revolving around things in the Green Zone can be -made freely. However, once decisions have been made on details in the Green Zone, they will enter +made freely. + +??? success "Green Zone" + Decisions can be made freely + +  However, once decisions have been made on details in the Green Zone, they will enter the Yellow Zone. Decisions can not be made in the Yellow Zone without discussing with the team, as -this could undermine other decisions without proper discussion. And finally once writing has -actually taken place for details in the Yellow Zone, those details enter the Red Zone. Nothing in -the Red Zone should change unless absolutely necessary. +this could undermine other decisions without proper discussion. + +??? warning "Yellow Zone" + New decisions/changes must be discussed + +  And finally once writing has actually taken place for details in the Yellow Zone, +those details enter the Red Zone. Nothing in the Red Zone should change unless absolutely necessary. + +??? danger "Red Zone" + Changes should not be made except under exceptional circumstances   This system hinges on two things, communication and communication. When story decisions/ideas arise while meeting with other teams, please note them down so that we can all be aware of what is diff --git a/mkdocs.yml b/mkdocs.yml index eb3b1ea..b470c16 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,8 +40,6 @@ theme: # Navigation - navigation.tabs - navigation.tabs.sticky - - navigation.sections - - navigation.expand - navigation.indexes - navigation.top - navigation.footer @@ -88,10 +86,10 @@ nav: - tutorials/audio/index.md - Story: - tutorials/story/index.md + - Story Team Standards: tutorials/story/story-team-standards.md - Story Design Doc: tutorials/story/story-design-doc.md - Story Team Tasks: tutorials/story/story-tasks.md - Story Team Onboarding: tutorials/story/story-team-onboarding.md - - Story Team Standards: tutorials/story/story-team-standards.md - General: - tutorials/general/index.md - Getting Set Up: tutorials/general/getting-set-up.md