Skip to content

Commit

Permalink
Add contributing instructions for Tri-M
Browse files Browse the repository at this point in the history
  • Loading branch information
thatrobotdev committed Nov 1, 2023
1 parent 9bb572a commit f3416d8
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 8 deletions.
1 change: 0 additions & 1 deletion docs/concert-choir/unit-1/the-staff.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import StaffLinesSpacesSVG from '../../assets/img/staffLinesSpaces.svg';
import TheStaffVideoWebm from '../../assets/video/The Staff/The Staff.webm';
import TheStaffVideoThumbnailWebp from '../../assets/video/The Staff/The Staff thumbnail.webp';
import TheStaffVideoThumbnailJpg from '../../assets/video/The Staff/The Staff thumbnail.jpg';

import TheStaffVideoMP4 from '../../assets/video/The Staff/The Staff.mp4';

import staffPDF from '../../assets/doc/The Staff.pdf';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
import Admonition from '@theme/Admonition';
import IconEdit from '@theme/Icon/Edit';

# How to Contribute
# Overview

<figure class="card card__body" style={{display: 'inline-flex', float: 'right'}}>

<img alt="Gif of a brown bear hugging a panda by tietkimthao219 on tenor" src="/img/bear-cavalry.png" width="200"/>

<figcaption>
<footer class="card__footer">
[\#43: Bear Cavalry](https://octodex.github.com/bear-cavalry/) by [Cameron McEfee](https://github.com/cameronmcefee)
</footer>
</figcaption>
</figure>

If you're reading this page, you're probably interested in contributing to the project. Thank you! We welcome contributions from anyone at Peak to Peak Charter School (or anyone on the internet!), and are grateful for all improvements! This page will help you get started, even if it's your first time contributing to an open source project!

Expand Down
85 changes: 85 additions & 0 deletions docs/how-to-contribute/tri-m.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TheStaffVideoWebm from '../assets/video/The Staff/The Staff.webm';
import TheStaffVideoThumbnailWebp from '../assets/video/The Staff/The Staff thumbnail.webp';
import TheStaffVideoThumbnailJpg from '../assets/video/The Staff/The Staff thumbnail.jpg';
import TheStaffVideoMP4 from '../assets/video/The Staff/The Staff.mp4';

# Tri-M

Are you a member of Peak to Peak Charter School's [Tri-M Music Honor Society](https://nafme.org/student-opportunities/tri-m-music-honor-society/) and want to contribute to the site?

Here are some Tri-M specific volunteering opportunities!

## Make videos for the P2P Community!

[Follow these instructions](https://docs.google.com/document/d/1n6DzlXjy9rgFDP-5kqoCzEmPCkzlVCR5BQBEvt_kYyY/edit?usp=sharing) to make and submit videos to be transferred to the site!

## Video Examples
Videos in many different styles are uploaded to the site. Not all of them are specific to theorybear. You do not need to emulate the style of the other videos, feel free to make your own!

### theorybear specific

This video was created with a specific page, content, and audience in mind. Because it was created for theorybear itself, it was uploaded and embedded from the [theorybear YouTube channel](https://www.youtube.com/@theorybear). For help uploading your own videos to this YouTube channel (not a requirement for the video to be embedded, you can upload to your own YouTube channel or just send the raw video file), contact JP!

<Tabs>
<TabItem value="youtube" label="YouTube" default>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/9NkIWXVRF1w?si=nqK6IlantGfMfjo4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
<TabItem value="theorybear" label="theorybear" default>
<video controls width="560" height="315" poster={TheStaffVideoThumbnailJpg} preload="none">
<picture>
<source srcset={TheStaffVideoThumbnailWebp} type="image/webp" />
<source srcset={TheStaffVideoThumbnailJpg} type="image/jpeg" />
<img src={TheStaffVideoThumbnailJpg} alt="Thumbnail for The Staff video" />
</picture>
{/* <track default kind="captions" srclang="en" src={useBaseUrl('../captions/The Staff captions.vtt')} /> */}
<source src={TheStaffVideoWebm} type="video/webm" />
<source src={TheStaffVideoMP4} type="video/mp4" />
Download the
<a href={TheStaffVideoWebm}>WEBM</a>
or
<a href={TheStaffVideoMP4}>MP4</a>
video.
</video>
</TabItem>
</Tabs>

### From around the internet

Sometimes a video on the internet is so useful or engaging that it's a better idea to use it instead of making our own video! For example, this video from Louie Zong that pokes fun at polythythms:
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/a-EI30uucng" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Videos from the internet are never embedded as a file, only the YouTube video is embedded. For more information, see [Embedding](#embedding).

## Embedding

### YouTube Embeds
Embedding videos from YouTube is usually allowed by the creator, but YouTube allows creators to prevent embedding of their videos on external sites. If that is the case, please respect that creator's wishes and do not attempt to embed the video on the site. [Follow these instructions](https://support.google.com/youtube/answer/171780?hl=en) to get the video embed code from YouTube, and try to enable "Privacy Enhanced Mode" to prevent the video from loading fully until a user clicks on it.

### File embeds
When videos are embedded to theorybear, sometimes they will be tabbed like this:
<Tabs>
<TabItem value="youtube" label="YouTube" default>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/9NkIWXVRF1w?si=nqK6IlantGfMfjo4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
<TabItem value="theorybear" label="theorybear" default>
<video controls width="560" height="315" poster={TheStaffVideoThumbnailJpg} preload="none">
<picture>
<source srcset={TheStaffVideoThumbnailWebp} type="image/webp" />
<source srcset={TheStaffVideoThumbnailJpg} type="image/jpeg" />
<img src={TheStaffVideoThumbnailJpg} alt="Thumbnail for The Staff video" />
</picture>
{/* <track default kind="captions" srclang="en" src={useBaseUrl('../captions/The Staff captions.vtt')} /> */}
<source src={TheStaffVideoWebm} type="video/webm" />
<source src={TheStaffVideoMP4} type="video/mp4" />
Download the
<a href={TheStaffVideoWebm}>WEBM</a>
or
<a href={TheStaffVideoMP4}>MP4</a>
video.
</video>
</TabItem>
</Tabs>

These embedded videos have both a YouTube version and a version embedded as a file, so that if a user cannot access YouTube or the video is unavailable that there is a backup.
9 changes: 8 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ const config = {
},
blog: {
blogTitle: "theorybear blog!",
blogDescription: "theorybear's blog about music theory, music opportunities, and more!",
blogDescription:
"theorybear's blog about music theory, music opportunities, and more!",
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
Expand Down Expand Up @@ -84,6 +85,12 @@ const config = {
label: "Blog",
position: "left",
},
{
type: "docSidebar",
sidebarId: "howToContribute",
position: "left",
label: "How To Contribute",
},
],
},
footer: {
Expand Down
5 changes: 4 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,10 @@ const sidebars = {
},
"singing-tips",
"additional-resources",
"how-to-contribute",
],
howToContribute: [
"how-to-contribute/overview",
"how-to-contribute/tri-m",
],
};

Expand Down
15 changes: 12 additions & 3 deletions src/components/Alert/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,23 @@ import styles from './styles.module.css';

export default function Alert(): JSX.Element {
return (
<section className="container">
<section className="container">
{/* Fat Bear Week
<Admonition type="info" icon="🐻" title="Fat Bear Week 2023">
<p>It's Fat Bear Week! Meet the bears and <a href="https://explore.org/fat-bear-week" target="_blank" rel="noreferrer">vote for your favorite!</a></p>
<details>
<summary>Live Bear Cam</summary>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/HsLvnFQW_yM?si=tEIsx_yPzy0sa7rZ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</details>
</Admonition>
</section>
</Admonition>
*/}
{/* Contributors */}
<Admonition type="info" icon="🐻" title="Accepting contributors!">
<p>
Are you a Hack Club, Tri-M, or CSHS member? We need you to improve
this site! <a href="/docs/how-to-contribute/overview">Find out more here.</a>
</p>
</Admonition>
</section>
);
}
2 changes: 1 addition & 1 deletion src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export default function Home(): JSX.Element {
<Layout
title={`Hello from ${siteConfig.title}`}
description="A fun, supplemental guide to music theory education.">
{/* <Alert /> */}
<Alert />
<HomepageHeader />
<main>
<JpsCorner />
Expand Down
Binary file added static/img/bear-cavalry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f3416d8

Please sign in to comment.