diff --git a/2025/WI25/example/README.md b/2025/WI25/example/README.md new file mode 100644 index 0000000..67d3c73 --- /dev/null +++ b/2025/WI25/example/README.md @@ -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 element. +*/} + +# 1. Workshop Video + +*Will be added as soon as uploaded to YouTube* + +{/* +
+ +Screen reader-compatible alt text + +
+*/} + +{/* + 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 */}) diff --git a/2025/WI25/example/figures/Default_Header_Dark.png b/2025/WI25/example/figures/Default_Header_Dark.png new file mode 100644 index 0000000..1da1d18 Binary files /dev/null and b/2025/WI25/example/figures/Default_Header_Dark.png differ diff --git a/2025/WI25/example/figures/Default_Header_Light.png b/2025/WI25/example/figures/Default_Header_Light.png new file mode 100644 index 0000000..83a9850 Binary files /dev/null and b/2025/WI25/example/figures/Default_Header_Light.png differ diff --git a/2025/WI25/example/test.ipynb b/2025/WI25/example/test.ipynb new file mode 100644 index 0000000..200d7bb --- /dev/null +++ b/2025/WI25/example/test.ipynb @@ -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 +} diff --git a/internal/templates/single-workshop/README.md b/internal/templates/single-workshop/README.md index 55fd5c9..e5b59f2 100644 --- a/internal/templates/single-workshop/README.md +++ b/internal/templates/single-workshop/README.md @@ -3,29 +3,29 @@ title: "Title of Workshop" description: "Short description of the 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 repository. +The official ACM AI {/* Your Workshop Name */} repository. - 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! ---> +*/} - +*/} # 1. Workshop Video *Will be added as soon as uploaded to YouTube* - repository. /> ---> +*/} - +*/} # 2. File Directory Structure @@ -86,42 +86,42 @@ nlp-series | -- README.md ``` - +*/} # 3. Getting Started - +*/} - +*/} # 4. Resources - +*/} - [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandot.com on YouTube - +*/} # 5. Author Info -- Person One: [LinkedIn]() | [GitHub]() -- Person Two: [LinkedIn]() | [GitHub]() +- Person One: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */}) +- Person Two: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */}) diff --git a/internal/templates/workshop-series/README.md b/internal/templates/workshop-series/README.md index 1c657e8..5828de5 100644 --- a/internal/templates/workshop-series/README.md +++ b/internal/templates/workshop-series/README.md @@ -3,30 +3,30 @@ title: "Title of Series" description: "Short description of the series." --- - +*/} - +*/} - +*/} ![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./Default_Main_Header_Light.png#gh-light-mode-only) ![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./Default_Main_Header_Dark.png#gh-dark-mode-only) -The official ACM AI repository. +The official ACM AI {/* Your Series Name */} repository. - 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! ---> +*/} - +*/} # 1. File Directory Structure @@ -63,46 +63,46 @@ nlp-series | -- README.md ``` - +*/} # 2. Getting Started ## 2.1 Workshop 1 - +*/} This workshop is so great guys trust me. - +*/} # 3. Resources ## 3.1 Workshop 1 - +*/} - [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandotcom on YouTube - +*/} # 4. Author Info -- Person One: [LinkedIn]() | [GitHub]() -- Person Two: [LinkedIn]() | [GitHub]() +- Person One: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */}) +- Person Two: [LinkedIn]({/* LinkedIn link */}) | [GitHub]({/* GitHub link */}) diff --git a/internal/templates/workshop-series/workshop-1/README.md b/internal/templates/workshop-series/workshop-1/README.md index b778c18..93cdfae 100644 --- a/internal/templates/workshop-series/workshop-1/README.md +++ b/internal/templates/workshop-series/workshop-1/README.md @@ -3,30 +3,30 @@ title: "Title of Workshop 1" description: "Short description of Workshop 1." --- - +*/} - +*/} - +*/} ![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/DefaultW1_Header_Light.png#gh-light-mode-only) ![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/DefaultW1_Header_Dark.png#gh-dark-mode-only) -The official ACM AI - Workshop repository. +The official ACM AI {/* Your Series Name */} - Workshop {/*# */} repository. - - Workshop repository. - Anything else you'd like, but try not to be redundant! - Make sure it's not already in the main series README or another section ---> +*/} - +*/} # 1. Workshop Video *Will be added as soon as uploaded to YouTube* - - Workshop repository. /> ---> +*/} - +*/} # 2. File Directory Structure @@ -88,24 +88,24 @@ nlp-series | -- README.md ``` - +*/} # 3. Getting Started - +*/} This workshop is so great guys trust me. -Workshop consists of components: -- [Notebook]() with completed code and explanations. -- [Summary Graphic]() to summarize key points of the workshop. +Workshop {/*# */} consists of {/* however many you choose */} components: +- [Notebook]({/* Local Path to Notebook */}) with completed code and explanations. +- [Summary Graphic]({/* Local Path to Summary Graphic */}) to summarize key points of the workshop. - +*/}