Skip to content

Commit

Permalink
Begins Volunteer section reorganization. (#87)
Browse files Browse the repository at this point in the history
* removes priority labels from Issue Labels page.

* Volunteer Sidebar Reorganization

* fixes broken links.

* fixed all the broken links I hope

* removed numbering on volunteering directories.
  • Loading branch information
enigmalea authored Sep 11, 2023
1 parent 6c9601e commit 14d3cfe
Show file tree
Hide file tree
Showing 26 changed files with 549 additions and 502 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ TODO[Ms.Boba]: Create a intro page to help people with a specific skill (or desi

## Step 0 - Sign up for a GitHub Account

In order to submit code, you will need a [GitHub account](https://github.com/). You can read more about GitHub in our [Knowledge Base](/docs/volunteering/github/understanding-github).
In order to submit code, you will need a [GitHub account](https://github.com/). You can read more about [Using Github](/docs/volunteering/coding/github/understanding-github).

## Step 1 - Take a look at open issues

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ For a step-by-step guide to setting up WSL, installing the below pre-requisites,

### Git/GitHub

**You will use Git and a [GitHub](https://github.com/) account to download the BobaBoard code, make changes and send them out for review. **You can [learn more about Git and GitHub](/docs/volunteering/github/understanding-github) in our knowledge base.
**You will use Git and a [GitHub](https://github.com/) account to download the BobaBoard code, make changes and send them out for review. **You can [learn more about Git and GitHub](/docs/volunteering/coding/github/understanding-github) in our knowledge base.

To install git, follow the [instructions on GitHub](https://github.com/git-guides/install-git). While this documentation assumes you're using git through the command line, using GitHub Desktop or VSCode's Git(Hub) integration might provide an easier experience for newcomers.

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/users/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ You can provide feedback by:

- posting in the **!bobaland** Board for your Realm
- opening a [Github Issue](https://github.com/BobaBoard/issues/issues)
- becoming a [volunteer](/docs/volunteering/intro)
- becoming a [volunteer](/docs/volunteering)
4 changes: 4 additions & 0 deletions docusaurus/docs/volunteering/coding/github/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 3
title: Using Github
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Selecting An Issue
---

- Types of contributions
- For code beginners
- For code experts
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/volunteering/coding/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 4
title: Coding Team
---
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ This guide will show you how to edit BobaDocs, the website that you're looking a

You will need:

- A [GitHub](https://github.com) account. (A brief explanation of GitHub is available in our [Knowledge Base](/docs/volunteering/github/understanding-github). Any `git terminology` use in this guide is also explained there.)
- A [GitHub](https://github.com) account. (A brief explanation of GitHub is available in our [Knowledge Base](/docs/volunteering/coding/github/understanding-github). Any `git terminology` use in this guide is also explained there.)

You will NOT need:

- Any knowledge of command lines.

## Step 0: Create your own copy of BobaDocs

Only the BobaLord is allowed to modify the original copy of BobaDocs. To make changes, you'll have to your own copy of the files. This process is called forking, and you can read more about it in our [knowledge base](/docs/volunteering/github/understanding-github).
Only the BobaLord is allowed to modify the original copy of BobaDocs. To make changes, you'll have to your own copy of the files. This process is called forking, and you can read more about it in our [knowledge base](/docs/volunteering/coding/github/understanding-github).

**If you already have a copy of BobaDocs, skip to [Keeping your files updated](#keeping-your-files-updated).**

Expand All @@ -31,7 +31,7 @@ Here are the steps to do this:

:::tip

By the way! To do this right, you'd also need to branch. Read our [knowledge base](/docs/volunteering/github/understanding-github) to learn more about branching.
By the way! To do this right, you'd also need to branch. Read our [knowledge base](/docs/volunteering/coding/github/understanding-github) to learn more about branching.

:::

Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/volunteering/communications/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 5
title: Communications Team
---
4 changes: 4 additions & 0 deletions docusaurus/docs/volunteering/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 6
title: Community Team
---****
4 changes: 4 additions & 0 deletions docusaurus/docs/volunteering/experience/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 2
title: The Volunteer Experience
---
10 changes: 10 additions & 0 deletions docusaurus/docs/volunteering/general/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 3
title: General Info
---

:::TODO

Consider renaming this section.

:::
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Intro
---
sidebar_position: 4
title: Open Positions
---


This sections will contain a list of open positions, their requirements and expectations.

Expand Down
4 changes: 0 additions & 4 deletions docusaurus/docs/volunteering/github/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docusaurus/docs/volunteering/positions/_category_.json

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 15
---

# Expectations & Code of Conduct
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
sidebar_position: 1
title: The BobaBoard Team(s)
slug: /volunteering
---

# Volunteering

:::tip

**This guide and the surrounding processes are a living document.** Volunteers and other BobaBoard stakeholders are empowered to propose changes, adjustments and additions.
Expand All @@ -23,7 +23,7 @@ The goal of both staff and volunteers is to create spaces and processes that ena
- A welcoming and enriching experience for beginners and experts alike.
- An encouraging, judgement-free environment to develop new skills in, or to hone pre-existing ones.
- The opportunity for motivated individuals to make an impact, and to have their contributions publicly recognized to the extent they're comfortable with.
- A leadership style mindful of the experience of marginalized communities, proactive in addressing their needs, and supportive of proposed changes within the boundaries of its [code of conduct](./code-of-conduct).
- A leadership style mindful of the experience of marginalized communities, proactive in addressing their needs, and supportive of proposed changes within the boundaries of its [code of conduct](/docs/volunteering/team/code-of-conduct).

**Reaching and upholding these goals is a collective, continuos effort.** If you wish to propose changes, believe we're falling short of our commitments, or have other concerns, you can open an issue on GitHub, contact Ms. Boba, or take advantage of our anonymous volunteering feedback form.

Expand All @@ -35,7 +35,7 @@ The goal of both staff and volunteers is to create spaces and processes that ena

## The volunteering expectations

While BobaBoard strives to embody the chaotic and transgressive spirit of some corners of transformative fandom, **we expect volunteers and staff to approach their roles and tasks with seriousness and respect**, and to familiarize themselves with our [code of conduct](./code-of-conduct).
While BobaBoard strives to embody the chaotic and transgressive spirit of some corners of transformative fandom, **we expect volunteers and staff to approach their roles and tasks with seriousness and respect**, and to familiarize themselves with our [code of conduct](/docs/volunteering/team/code-of-conduct).

**Active and clear communication is the most important quality of a successful volunteer**. This means volunteers are expected to:

Expand All @@ -60,7 +60,7 @@ We're currently focusing our efforts on improving the volunteering process **for
:::

1. **[Fill the tech volunteering form](https://docs.google.com/forms/d/e/1FAIpQLSdCX2_fZgIYX0PXeCAA-pfQrcLw_lSp2clGHTt3uBTWgnwVSw/viewform)** to get access to our volunteers Discord server and our test community while BobaBoard is still in its closed alpha phase.
2. **[Familiarize yourself with BobaBoard codebases.](../engineering/intro)** BobaBoard's architecture is modular by design. If you're particularly interested in a specific area of work, follow the corresponding instructions to install a local copy.
2. **[Familiarize yourself with BobaBoard codebases.](/docs/engineering/intro)** BobaBoard's architecture is modular by design. If you're particularly interested in a specific area of work, follow the corresponding instructions to install a local copy.
3. **Familiarize yourself with the current roadmap and focus areas.** Volunteering expectations may vary according to the urgency of the task. If you're an expert developer with short-term availabilty, you're welcome to help with issues in the critical path. Beginners may want to start with improvements in non-urgent areas of focus.

:::warning
Expand Down
4 changes: 0 additions & 4 deletions docusaurus/docs/volunteering/writing/_category_.json

This file was deleted.

5 changes: 2 additions & 3 deletions docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ module.exports = {
activeBaseRegex: "docs/engineering",
},
{
type: "doc",
docId: "volunteering/intro",
to: "docs/volunteering/",
position: "left",
label: "Volunteering Guide",
},
Expand Down Expand Up @@ -75,7 +74,7 @@ module.exports = {
},
{
label: "Volunteering Guide",
to: "/docs/volunteering/intro",
to: "/docs/volunteering",
},
{
label: "User Guide",
Expand Down
10 changes: 5 additions & 5 deletions docusaurus/src/pages/index.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import React from "react";
import clsx from "clsx";
import HomepageFeatures from "../components/HomepageFeatures";
import Layout from "@theme/Layout";
import Link from "@docusaurus/Link";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import React from "react";
import clsx from "clsx";
import styles from "./index.module.css";
import HomepageFeatures from "../components/HomepageFeatures";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";

function HomepageHeader() {
const { siteConfig } = useDocusaurusContext();
Expand All @@ -16,7 +16,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/volunteering/intro"
to="/docs/volunteering"
>
Volunteer with us 💼
</Link>
Expand Down
Loading

0 comments on commit 14d3cfe

Please sign in to comment.