Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.

Adding Taimur's changes #20

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
28 changes: 28 additions & 0 deletions how-to-contribute-to-workshops/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Workshops

## Purpose

Bit Project implements workshops in order to help students, regardless of their level of technical knowledge, develop pertinent skills and learn new technologies.

## Workshop Format

These workshops are typically created in the form of slides/ presentations along with an interactive activity in which students can apply the knowledge that they gained throughout the presentation. Note that this interactive activity is **NOT** of the form of a "quiz" game, but rather, is an activity which allows students to critically think about and apply what they have learned (See [How to Contribute to Workshops](./How-to-contribute-to-workshops.md) for more details).

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the link here is not very necessary, since you did not talk about what activities are in the how-to-contribute-to-workshops.md. Maybe link an example of a workshop slides instead?

## Current Workshops

Bit Project has workshops in areas including:

- Intro to React
- Leetcode
- Twitter APIs
- Sketch Together
- Dodge
- GitHub
- MongoDB
- Postman
- Pusher

## New Workshops

If you have an idea for a new workshop, would like to contribute to any existing workshop, or wish to integrate a workshop you have already created, please refer to [How to Contribute to Workshops](./How-to-contribute-to-workshops.md).

60 changes: 60 additions & 0 deletions how-to-contribute-to-workshops/how-to-contribute-to-workshops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# How to Contribute to Workshops

## Basic Requirements for Integrating Any Workshop

For any workshop that you wish to contribute, ensure that it is sufficiently distinct from the workshops that Bit Project currently has. See <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization#step-1-workshop-proposal">Workshop Proposal</a> for the complete list of the workshops Bit Project currently has.

Successful integration of any workshop involves the following main stages and sub-stages:

* **Placing your work in GitBook**
* **Stage 1: Preparation**
* Step 1: Workshop Proposal
* Step 2: Interactive Component Idea
* Step 3: Responsibilities Delegated
* **Stage 2: Slides and Components**
* Step 1: Presentation Slides Outline
* Step 2: Completing Slides and Interactive Component
* **Stage 3: Presentation**
* Step 1: Presentation Practice
* Step 2: Present to Bit & Organization

For detailed information about each step and sub-step of the above workflow, see <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization">Joining as an Organization</a>.

<h2 id = "Porting">Porting an Existing Workshop Into Our System

If you wish to contribute an existing workshop, ensure that all requirements outlined in <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization">Joining as an Organization</a> have been met and make edits to your workshop as neccessary.

You should be writing the content of each slide of your presentation in individual Markdown files; that is, each Markdown file corresponds to one slide of the presentation. Each Markdown file should (if applicable) contain the following information:

* Type of slide (i.e. title slide, centered text, link + code, code centered, etc.)
* Title of slide
* Text of slide
* Images on slide
* Code on slide
* Speaker notes

In these Markdown files, it is essential that you not only provide the literal text that will go on the slide, but also add any additional notes about formatting, organization, etc. so that when the files are to be converted to slides, it is clear to **anyone** exactly how the slide should be formatted. For example, in the Markdown file, bold words that should be bolded on the slide and indicate if a certain text should be highlighted, underlined, etc. in the final product.

For details about placing your work in GitBook, see <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization#placing-your-work-in-gitbook">Placing your work in GitBook</a>.

## Adding a Workshop in Collaboration with a Company

If you have a workshop in collaboration with a company that you would like to contribute, convert the content of the company's work into Markdown files, where a single Markdown file corresponds to a single slide of the presentation. See <a href = "#Porting">Porting an Existing Workshop Into Our System</a> for a general outline of how to create the Markdown files. Make sure to provide adequate credit to the company.

Ensure that these presentations align with the requirements outlined in <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization">Joining as an Organization</a>. To integrate the work into our system, see <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization#placing-your-work-in-gitbook">Placing your work in GitBook</a>.

## Developing Workshops From Existing Activities/Labs

In order to convert our existing activities/labs into workshops, you should still follow the guidelines outlined in <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization">Joining as an Organization</a>. The following are additional recommendations for how you can effectively convert an activity or lab into a workshop.

* Do NOT blindly copy/paste the information from the activity or lab to use in the presentation. This will often lead to an overwhelming amount of text on the screen. Instead, summarize the main points on the Markdown file corresponding to each slide and use speaker notes to fill in more detailed information that the presenter will explain to the audience.
* Use plenty of images that presenters can use to explain concepts, helping minimize word count on each respective Markdown file/slide. These images do not necessarily need to be a part of the activity or lab themselves, but they should be related to the content on the slide.
* Integrate code snippets as neccessary.
* Try not to have more than one card from an activity/lab represented on a single Markdown file (which corresponds with a slide). If you find yourself doing this, it probably means that you are including too much text or not adequately presenting each card.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think you could add the link to the documentation I created about developing workshops from cards. Then the bullet point can be shorter and more brief.

## School Onboarding

One of the main goals of Bit Project is to expand by having other schools join and actively participate in developing curriculum. Such holds for contributing to workshops as well.

Schools that are interested in integrating their workshops or helping in developing workshops should see <a href = "https://about.bitproject.org/teams/developer-relations/joining-as-an-organization">Joining as an Organization</a> for detailed information on how they can do so.