Merge pull request #26 from sfuosdev/issue-22/tips-execs

Yonny04 · web-flow · commit b361e43b1db8 · 2025-01-16T22:27:12.000-08:00
tips page for execs and project lead
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2023-01-16-pm/what-is-pm.md b/blog/2023-01-16-pm/what-is-pm.md
@@ -0,0 +1,10 @@
+---
+slug: project management
+title: Project Management in Software Development
+authors: [tommy]
+tags: [project-management]
+---
+
+<!-- truncate -->
+
+placeholder
diff --git a/blog/2024-01-16-execs/execs.md b/blog/2024-01-16-execs/execs.md
@@ -0,0 +1,10 @@
+---
+slug: executives
+title: Executives in the club
+authors: [tommy]
+tags: [executives]
+---
+
+<!-- truncate -->
+
+placeholder
diff --git a/blog/2025-01-10-docusaurus/blog.md b/blog/2025-01-10-docusaurus/blog.md
@@ -1,10 +1,12 @@
 ---
-slug: welcome
-title: Welcome
-authors: [slorber, yangshun]
-tags: [facebook, hello, docusaurus]
+slug: how to write blog
+title: How to write blog
+authors: [tommy]
+tags: [how-to-use, docusaurus]
 ---
 
+Below description is from Docusaurus basic description of how to write blog.
+
 [Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
 
 Here are a few tips you might find useful.
@@ -26,4 +28,4 @@ A blog post folder can be convenient to co-locate blog post images:
 
 The blog supports tags as well!
 
-**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
diff --git a/blog/2025-01-10-docusaurus/docusaurus-plushie-banner.jpeg b/blog/2025-01-10-docusaurus/docusaurus-plushie-banner.jpeg
diff --git a/blog/2025-01-10-docusaurus/mdx-blog-post.mdx b/blog/2025-01-10-docusaurus/mdx-blog-post.mdx
@@ -1,8 +1,8 @@
 ---
-slug: mdx-blog-post
-title: MDX Blog Post
-authors: [slorber]
-tags: [docusaurus]
+slug: docusaurus-mdx-blog-post
+title: MDX blog post
+authors: [tommy]
+tags: [how-to-use, docusaurus]
 ---
 
 Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
@@ -18,7 +18,7 @@ Use the power of React to create interactive blog posts.
 For example, use JSX to create an interactive button:
 
 ```js
-<button onClick={() => alert('button clicked!')}>Click me!</button>
+<button onClick={() => alert("button clicked!")}>Click me!</button>
 ```
 
-<button onClick={() => alert('button clicked!')}>Click me!</button>
+<button onClick={() => alert("button clicked!")}>Click me!</button>
diff --git a/blog/2025-01-16-purpose-of-blog-feature.md b/blog/2025-01-16-purpose-of-blog-feature.md
@@ -0,0 +1,61 @@
+---
+slug: welcome
+title: Purpose of blog feature
+authors: [tommy]
+tags: [how-to-use, docusaurus]
+---
+
+<!-- truncate -->
+
+The SFU Open Source Development Club will use the Docusaurus Blog feature to document the responsibilities and tips of project leads and club executives. The blogs can be based on personal experience or basic knowledge.
+
+With permission from the club presidents, any SFU OS Dev Club executives, ex-executives, project leads (project managers), and project members can write blog posts. Blog posts can be .md or .mdx format.
+
+If you are willing to write blog, please make your profiles in <code>authors.yml</code>:
+
+```yml
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png
+  page:
+    # customize the url of the author page at /blog/authors/<permalink>
+    permalink: "/all-sebastien-lorber-articles"
+  socials:
+    x: sebastienlorber
+    linkedin: sebastienlorber
+    github: slorber
+    newsletter: https://thisweekinreact.com
+```
+
+and attach this to your blog post at the top:
+
+```yml
+---
+slug: welcome
+title: Purpose of blog feature
+authors: [tommy]
+tags: [how-to-use, docusaurus]
+---
+```
+
+If there are multiple authors for one blog post, please make both author profiles in <code>authors.yml</code> and add it like example below:
+
+```yml
+---
+slug: first-blog-post
+title: First Blog Post
+authors: [slorber, yangshun]
+tags: [hola, docusaurus]
+---
+```
+
+You are welcome to create tags for your blog post such as this in <code>tags.yml</code>:
+
+```yml
+executives:
+  label: Executives
+  permalink: /executives
+  description: Executives tag description
+```
diff --git a/blog/authors.yml b/blog/authors.yml
@@ -1,23 +1,25 @@
-yangshun:
-  name: Yangshun Tay
-  title: Front End Engineer @ Facebook
-  url: https://github.com/yangshun
-  image_url: https://github.com/yangshun.png
-  page: true
-  socials:
-    x: yangshunz
-    github: yangshun
+# saving this as an example for future reference
 
-slorber:
-  name: Sébastien Lorber
-  title: Docusaurus maintainer
-  url: https://sebastienlorber.com
-  image_url: https://github.com/slorber.png
-  page:
-    # customize the url of the author page at /blog/authors/<permalink>
-    permalink: '/all-sebastien-lorber-articles'
+# slorber:
+#   name: Sébastien Lorber
+#   title: Docusaurus maintainer
+#   url: https://sebastienlorber.com
+#   image_url: https://github.com/slorber.png
+#   page:
+#     # customize the url of the author page at /blog/authors/<permalink>
+#     permalink: '/all-sebastien-lorber-articles'
+#   socials:
+#     x: sebastienlorber
+#     linkedin: sebastienlorber
+#     github: slorber
+#     newsletter: https://thisweekinreact.com
+
+tommy:
+  name: Tommy Oh
+  title: President @ SFU OS Dev club
+  url: https://github.com/TommyOh0428
+  image_url: https://github.com/TommyOh0428.png
+  page: true
   socials:
-    x: sebastienlorber
-    linkedin: sebastienlorber
-    github: slorber
-    newsletter: https://thisweekinreact.com
+    linkedin: tommy-oh-766450217
+    github: TommyOh0428
diff --git a/blog/tags.yml b/blog/tags.yml
@@ -1,3 +1,18 @@
+how-to-use:
+  label: How to Use
+  permalink: /how-to-use
+  description: How to Use tag description
+
+project-management:
+  label: Project Management
+  permalink: /project-management
+  description: Project Management tag description
+
+executives:
+  label: Executives
+  permalink: /executives
+  description: Executives tag description
+
 facebook:
   label: Facebook
   permalink: /facebook
diff --git a/docs/intro.md b/docs/intro.md
@@ -2,46 +2,33 @@
 sidebar_position: 1
 ---
 
-# Tutorial Intro
+# Introduction
 
-Let's discover **Docusaurus in less than 5 minutes**.
+Welcome to SFU Open Source Development Club! We are an official student club at Simon Fraser University aimed at bringing talented individuals from technology, design, and business. This documentation tool is built using [Docusaurus](https://docusaurus.io/), open source tool made by Meta (Facebook).
 
-## Getting Started
+## Purpose of this tool
 
-Get started by **creating a new site**.
+This tool has been designed to support current and future students in Computer Science, Software Systems, Computer Engineering, and Computer Science Minor, as well as anyone interested in starting their journey in Computer Science. Our goal is to provide valuable resources that will help individuals excel in group projects and stay ahead in their academic and professional endeavours. In our club documentation tool, there will be topics that you need to know for software development, such as how to use git, software development cycle, etc. We hope you learn a lot from this and impact future software projects!
 
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+### SFU Open Source Development Club
 
-### What you'll need
+If you would like to know about us, click links below for more details:
 
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+For joining our Discord, please find SFU Open Source Dev Club in SFU student hub.
 
-## Generate a new site
+- Website: https://sfuosdev.com/
+- Github Organization page: https://github.com/sfuosdev
+- Instagram: https://www.instagram.com/sfu_osdev/
+- LinkedIn: https://www.linkedin.com/company/sfu-osdev/
 
-Generate a new Docusaurus site using the **classic template**.
+If you would like to join us? Welcome! Click the link below or click 'Join OS Dev' button top right corner:
 
-The classic template will automatically be added to your project after you run the command:
+- SFSS: https://go.sfss.ca/clubs/867/info
 
-```bash
-npm init docusaurus@latest my-website classic
-```
+## Contribution
 
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+While this tool exists for current and future students in technology, you can also write useful documentation for your future colleagues. Your contribution will be helpful for both the club and future colleagues, and we appreciate your help!
 
-The command also installs all necessary dependencies you need to run Docusaurus.
+### How to Contribute
 
-## Start your site
-
-Run the development server:
-
-```bash
-cd my-website
-npm run start
-```
-
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
-
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
-
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
+We have written a step-by-step tutorial in our Docs Github repository. To access it, please go to our [Docs repository](https://github.com/sfuosdev/Docs) or click the 'contribute' button at the header.
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -77,12 +77,16 @@ const config: Config = {
           position: "left",
           label: "Tutorial",
         },
+        {
+          to: "/blog",
+          label: "PM / Exec",
+          position: "left",
+        },
         {
           label: "Contribute",
           position: "left",
           href: "https://github.com/sfuosdev/Docs?tab=readme-ov-file#how-to-contribute",
         },
-        // {to: '/blog', label: 'Blog', position: 'left'},
         {
           href: "https://github.com/sfuosdev",
           label: "OS Dev Github",
@@ -105,6 +109,10 @@ const config: Config = {
               label: "Tutorial",
               to: "/docs/intro",
             },
+            {
+              label: "PM / Exec",
+              to: "/blog",
+            },
           ],
         },
         {
