Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example of workshop page creation #38

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
127 changes: 127 additions & 0 deletions 2025/WI25/example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
title: "Example Page"
description: "Short description of the workshop."
---

{/*
The above is REQUIRED YAML Frontmatter so the README can be rendered
in the ACM Wiki. DO NOT move the frontmatter from its location.
It is also ESSENTIAL to fill out; make it good!
*/}

{/*
If you have any questions about this template, feel free to ask
your Director for help!
*/}

{/*
SECTION: Header
---------
Request new headers from you Director to fit your workshop!
*/}

![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Light.png#gh-light-mode-only)
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Dark.png#gh-dark-mode-only)

The official ACM AI {/* Your Workshop Name */} repository.

{/*
Mandatory Sections:
- File Directory Structure
- Workshop Recording
- if you recorded your workshop, please make it available here
- Getting Started
- Give an interesting description of your workshop!
- E.g. you can use the marketing descriptiong (w/o the emojis
and make the nouns general ('you' becomes 'the reader'))
- Resources
- Images, papers, etc
- Author Info
- About yourself! This is so you get credit for your work!
Other Possible Sections:
- Datasets
- Separate from 'Resources' to distinguish between inspiration and
things like datasets used in a notebook
- Anything else you'd like, but try not to be redundant!
*/}

{/*
SECTION: Workshop Video
---------
Most, if not all, workshops should have recordings. Once the recording
is posted to the ACMUCSD YT channel (https://www.youtube.com/channel/UCyjPATFqc3FwOiuqJ2UG1Eg),
replace the text with an <img> element.
*/}

# 1. Workshop Video

*Will be added as soon as uploaded to YouTube*

{/*
<div align="center">
<a href="YT Video Link">
<img
src="YT Max Res Thumbnail Link"
alt="Screen reader-compatible alt text"
width="500px"
/>
</a>
</div>
*/}

{/*
SECTION: File Directory Structure
---------
Write out your File Directory Structure below (make sure it's up-to-date)
*/}

# 2. File Directory Structure

```bash
nlp-series
| -- figures
| -- Default_Header_Dark.png
| -- Default_Header_Light.png
| -- test.ipynb
| -- README.md
```

{/*
SECTION: Getting Started
---------
Brief description of your workshop here
*/}

# 3. Getting Started

{/*
You can write something up or use the marketing description.
*/}


{/*
SECTION: Resources
---------
Make sure to cite everything you use, whether directly or for inspiration!
*/}

# 4. Resources

{/*
List all your resources below; DO NOT skimp on this part!
*/}

- [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandot.com on YouTube


{/*
SECTION: Author Info
---------
Make sure to give yourself credit for your work by listing yourself and
your partners below! Add your LinkedIn and GitHub!
*/}

# 5. Author Info

- Person One: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})
- Person Two: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})
Binary file added 2025/WI25/example/figures/Default_Header_Dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions 2025/WI25/example/test.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Test Notebook"
]
},
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Hello World\n"
]
}
],
"source": [
"print(\"Hello World\")"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.7"
}
},
"nbformat": 4,
"nbformat_minor": 2
}
54 changes: 27 additions & 27 deletions internal/templates/single-workshop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ title: "Title of Workshop"
description: "Short description of the workshop."
---

<!--
{/*
The above is REQUIRED YAML Frontmatter so the README can be rendered
in the ACM Wiki. DO NOT move the frontmatter from its location.
It is also ESSENTIAL to fill out; make it good!
-->
*/}

<!--
{/*
If you have any questions about this template, feel free to ask
your Director for help!
-->
*/}

<!--
{/*
SECTION: Header
---------
Request new headers from you Director to fit your workshop!
-->
*/}

![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Light.png#gh-light-mode-only)
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Dark.png#gh-dark-mode-only)

The official ACM AI <!-- Your Workshop Name --> repository.
The official ACM AI {/* Your Workshop Name */} repository.

<!--
{/*
Mandatory Sections:
- File Directory Structure
- Workshop Recording
Expand All @@ -43,21 +43,21 @@ The official ACM AI <!-- Your Workshop Name --> repository.
- Separate from 'Resources' to distinguish between inspiration and
things like datasets used in a notebook
- Anything else you'd like, but try not to be redundant!
-->
*/}

<!--
{/*
SECTION: Workshop Video
---------
Most, if not all, workshops should have recordings. Once the recording
is posted to the ACMUCSD YT channel (https://www.youtube.com/channel/UCyjPATFqc3FwOiuqJ2UG1Eg),
replace the text with an <img> element.
-->
*/}

# 1. Workshop Video

*Will be added as soon as uploaded to YouTube*

<!--
{/*
<div align="center">
<a href="YT Video Link">
<img
Expand All @@ -67,13 +67,13 @@ The official ACM AI <!-- Your Workshop Name --> repository.
/>
</a>
</div>
-->
*/}

<!--
{/*
SECTION: File Directory Structure
---------
Write out your File Directory Structure below (make sure it's up-to-date)
-->
*/}

# 2. File Directory Structure

Expand All @@ -86,42 +86,42 @@ nlp-series
| -- README.md
```

<!--
{/*
SECTION: Getting Started
---------
Brief description of your workshop here
-->
*/}

# 3. Getting Started

<!--
{/*
You can write something up or use the marketing description.
-->
*/}


<!--
{/*
SECTION: Resources
---------
Make sure to cite everything you use, whether directly or for inspiration!
-->
*/}

# 4. Resources

<!--
{/*
List all your resources below; DO NOT skimp on this part!
-->
*/}

- [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandot.com on YouTube


<!--
{/*
SECTION: Author Info
---------
Make sure to give yourself credit for your work by listing yourself and
your partners below! Add your LinkedIn and GitHub!
-->
*/}

# 5. Author Info

- Person One: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
- Person Two: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
- Person One: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})
- Person Two: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */})
Loading