Skip to content

Commit c5cb34c

Browse files
authored
Merge pull request #446 from adiati98/docs/update-facilitators-docs
docs: Update the facilitators docs
2 parents 2bc2b89 + 7f5095c commit c5cb34c

File tree

1 file changed

+67
-88
lines changed

1 file changed

+67
-88
lines changed

monthly-challenges/facilitators-docs.md

Lines changed: 67 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@ The Monthly Challenge Team abides by the Virtual Coffee [Code of Conduct](https:
2424
- [Creating a Slack Reminder](#creating-a-slack-reminder)
2525
- [Scheduling a Thread](#scheduling-a-thread)
2626
- [Updating the Monthly Challenge Pages on the Website](#updating-the-monthly-challenge-pages-on-the-website)
27-
- [1. Creating a new challenge page](#1-creating-a-new-challenge-page)
28-
- [2. Updating the monthly challenge data](#2-updating-the-monthly-challenge-data)
29-
- [3. Updating the monthly challenge landing page](#3-updating-the-monthly-challenge-landing-page)
30-
- [4. Adding a success "completed challenge" alert to the previous challenge](#4-adding-a-success-completed-challenge-alert-to-the-previous-challenge)
27+
- [Creating a new challenge page](creating-a-new-challenge-page)
28+
- [Updating the monthly challenge landing page](updating-the-monthly-challenge-landing-page)
29+
- [Adding a success "completed challenge" alert to the previous challenge](adding-a-success-completed-challenge-alert-to-the-previous-challenge)
3130

3231
## Facilitating a Challenge
3332

@@ -39,7 +38,7 @@ If you have ideas for a new challenge(s), you can propose and discuss them in th
3938

4039
#### Coordinating with the Coffee Table Groups
4140

42-
We love collaboration! We're happy to involve our Coffee Table Groups in our challenges whenever possible. Besides giving more support to our community, our goal is that the community becomes more familiar with the Coffee Table Groups and can encourage them to attend the groups more and, ultimately, give them support through volunteering.
41+
We love collaboration! We're happy to involve our [Coffee Table Groups](https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/coffee-table-groups) in our challenges whenever possible. Besides giving more support to our community, our goal is that the community becomes more familiar with the Coffee Table Groups and can encourage them to attend the groups more and, ultimately, give them support through volunteering.
4342

4443
**Timeline**: When a challenge has been decided.
4544

@@ -87,7 +86,7 @@ We love collaboration! We're happy to involve our Coffee Table Groups in our cha
8786

8887
Navigate to the [`monthly-challenges`](../monthly-challenges/) folder and read the README file in the challenge folder for complete instructions.
8988

90-
See the "[Setting Up a Slack Bot](#setting-up-a-slack-bot)" section to learn more about working with Slack during the challenge.
89+
Learn more about using Slack during the challenge in the "[Setting Up a Slack Bot](#setting-up-a-slack-bot)" section.
9190

9291
### Post Challenge
9392

@@ -144,107 +143,87 @@ Even though most of our challenges remain the same as in previous years, we also
144143

145144
Every month, we update these pages with the challenge's description and instructions on participating. Here is how to update the pages:
146145

147-
#### 1. Creating a new challenge page
146+
#### Creating a new challenge page
148147

149-
- Go to `app/routes/__frontend/monthlychallenges`.
150-
- Create a new `jsx` file for the challenge. For example, `feb-2024.jsx`.
151-
- Write the content.
148+
1. Go to `src\app\monthlychallenges\(challenges)`.
149+
2. Create a new folder for the challenge and follow previous challenges for the naming format. For example, `sept-2024`.
150+
3. Create a `page.tsx` file in the folder.
151+
4. Write the content.
152152

153153
> [!NOTE]
154154
>
155155
> - For repeated challenges, you can copy and paste the content from the past challenge's file and update it to fit the upcoming challenge.
156-
> - For a brand-new challenge, you need to write the content from scratch to introduce and describe the challenge. You can use the format of any previous challenge.
156+
> - For a brand-new challenge, you need to write the content from scratch to introduce and describe it. However, you can use the format of any previous challenge.
157157
158-
#### 2. Updating the monthly challenge data
158+
#### Updating the monthly challenge landing page
159159

160-
- Go to `app/data/monthlyChallenges/getChallenges.ts`.
161-
- Update the data with the upcoming challenge data.
162-
163-
Here is an example, adding June 2024 challenge data:
164-
165-
```javascript
166-
import { handle as june2024 } from '~/routes/__frontend/monthlychallenges/june-2024'; // add this data
167-
import { handle as may2024 } from '~/routes/__frontend/monthlychallenges/may-2024';
168-
import { handle as apr2024 } from '~/routes/__frontend/monthlychallenges/apr-2024';
169-
...
170-
171-
const challenges: Challenge[] = [
172-
{ handleData: june2024, slug: 'june-2024' }, // add this data
173-
{ handleData: may2024, slug: 'may-2024' },
174-
{ handleData: apr2024, slug: 'apr-2024' },
175-
...
176-
];
177-
```
178-
179-
#### 3. Updating the monthly challenge landing page
180-
181-
- Go to `app/routes/__frontend/monthlychallenges/index.tsx`.
182-
- Remove the `current: true` from the previous challenge and set it for the new challenge.
183-
- Update the link to the blog post. If there is no blog post, comment it out.
184-
- Update the link to the challenge page.
185-
- Update the link of the previous challenge.
160+
1. Go to `src\app\monthlychallenges\page.tsx`.
161+
2. Remove the `current: true` from the previous challenge and set it for the new challenge.
162+
3. Update the link to the blog post. If there is no blog post, comment it out.
163+
4. Update the link to the challenge page.
164+
5. Update the link of the previous challenge.
186165

187166
Here is an example:
188167

189168
```javascript
190-
{
191-
current: true, // set for the new challenge
192-
title: 'Blogging Challenge',
193-
subtitle: `A Community Challenge to hit a word count goal for all our tech blogs.`,
194-
description: (
195-
<>
196-
<p>
197-
Based off the NaNoWriMo (National Novel Writing Month) Challenge, this
198-
challenge is the tech take on writing and working together towards the
199-
goal while posting on our own blogs.
200-
</p>
201-
// Update the link to a challenge blog post. If there is no blog post, comment out the paragraph.
202-
<p>
203-
Learn more about this challenge in{' '}
204-
<a href="https://dev.to/virtualcoffee/blogging-2023-monthly-challenge-3kng">
205-
this blog post
206-
</a>
207-
.
208-
</p>
209-
// Update the link to the new challenge page on the website
210-
<p>
211-
To view all of the details of this year's challenge,{' '}
212-
<Link to="/monthlychallenges/nov-2023">
213-
check out the November 2023 challenge page
214-
</Link>
215-
.
216-
</p>
217-
</>
218-
),
219-
links: [
220-
// Add the link and title of the previous challenge
221-
{
222-
href: '/monthlychallenges/nov-2022',
223-
title: 'November, 2022',
224-
},
225-
{
226-
href: '/monthlychallenges/nov-2021',
227-
title: 'November, 2021',
228-
},
229-
{
230-
href: '/monthlychallenges/nov-2020',
231-
title: 'November, 2020',
232-
},
233-
],
234-
},
169+
{
170+
current: true, // set for the new challenge
171+
title: 'Blogging Challenge',
172+
subtitle: `A Community Challenge to hit a word count goal for all our tech blogs.`,
173+
description: (
174+
<>
175+
<p>
176+
Based on the NaNoWriMo (National Novel Writing Month) Challenge, this
177+
challenge is the tech take on writing and working together towards the
178+
goal while posting on our own blogs.
179+
</p>
180+
// Update the link to a challenge blog post. If there is no blog post, comment out the paragraph.
181+
<p>
182+
Learn more about this challenge in{' '}
183+
<a href="https://dev.to/virtualcoffee/blogging-2023-monthly-challenge-3kng">
184+
this blog post
185+
</a>
186+
.
187+
</p>
188+
// Update the link to the new challenge page on the website
189+
<p>
190+
To view all of the details of this year's challenge,{' '}
191+
<Link to="/monthlychallenges/nov-2023">
192+
check out the November 2023 challenge page
193+
</Link>
194+
.
195+
</p>
196+
</>
197+
),
198+
links: [
199+
// Add the link and title of the previous challenge
200+
{
201+
href: '/monthlychallenges/nov-2022',
202+
title: 'November, 2022',
203+
},
204+
{
205+
href: '/monthlychallenges/nov-2021',
206+
title: 'November, 2021',
207+
},
208+
{
209+
href: '/monthlychallenges/nov-2020',
210+
title: 'November, 2020',
211+
},
212+
],
213+
},
235214
```
236215
237-
#### 4. Adding a success "completed challenge" alert to the previous challenge
216+
#### Adding a success "completed challenge" alert to the previous challenge
238217
239-
- Open the previous challenge file.
240-
- Add the alert right on top of `<h1>`.
241-
- Update the link to the new challenge.
218+
1. Open the `page.tsx` file in the previous challenge folder.
219+
2. Add the alert right on top of `<h1>`.
220+
3. Update the link to the new challenge.
242221
243222
Here is an example:
244223
245224
```javascript
246225
<div className="alert alert-success">
247226
This monthly challenge is complete. Congratulations! Please join us for the{' '}
248-
<Link to="/monthlychallenges/mar-2024">next challenge</Link>!
227+
<Link to="/monthlychallenges/dec-2023">next challenge</Link>!
249228
</div>
250229
```

0 commit comments

Comments
 (0)