Skip to content

Commit

Permalink
setup for tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
AdinAck committed Nov 7, 2024
1 parent f1d42e3 commit 36b1f34
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 3 deletions.
1 change: 1 addition & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ toc: false

{{< cards >}}
{{< card link="assignments" title="Assignments" icon="book-open" >}}
{{< card link="tutorials" title="Tutorials" icon="document-text" >}}
{{< card link="additional-resources" title="Resources" icon="external-link" >}}
{{< /cards >}}
1 change: 1 addition & 0 deletions content/assignments/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ All of the ECE 196 assignment instructions can be found here.
{{< card link="vu-meter" title="VU Meter" icon="chart-square-bar" >}}
{{< card link="spinning-and-blinking" title="Spinning and Blinking" icon="code" >}}
{{< card link="full-stack" title="Full Stack" icon="wifi" >}}
{{< card link="tutorial" title="Tutorial" icon="pencil" >}}
{{< /cards >}}
1 change: 1 addition & 0 deletions content/assignments/full-stack/submission.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Submission
type: docs
next: assignments/tutorial
weight: 3
---

Expand Down
45 changes: 45 additions & 0 deletions content/assignments/tutorial/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Tutorial
type: docs
prev: assignments/full-stack
weight: 6
---

For this assignment you will create a tutorial for the next generation of ECE 196 students.

If you go to the ECE 196 website homepage, you'll see a "Tutorials" section.

This is where your tutorials will go!

To get started with your tutorial, get the template from [here](https://github.com/ece-196/tutorial).

You will need to **clone** *this* repository and make a **pull request** to push your changes to this site.

Learn about pull requests [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

The ECE 196 website uses **Markdown** for writing documents which are rendered as webpages.

Learn about markdown [here](https://www.markdownguide.org).

The ECE 196 website repository file tree looks like:

{{< filetree/container >}}
{{< filetree/folder name="docs" >}}
{{< filetree/folder name="content" >}}
{{< filetree/folder name="additional-resources" state="closed" >}}
{{< /filetree/folder >}}
{{< filetree/folder name="assignments" state="closed" >}}
{{< /filetree/folder >}}
{{< filetree/folder name="tutorials" >}}
{{< filetree/file name="your_tutorial.md" >}}
{{< filetree/file name="_index.md" >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/folder >}}
{{< /filetree/container >}}

Create your tutorial where you see `your_tutorial.md`.

If your pull request is good, we'll accept it, if not, we'll leave comments to help you.

Once it is accepted, you have finished this assignment.
5 changes: 5 additions & 0 deletions content/tutorials/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Tutorials
cascade:
type: blog
---
9 changes: 6 additions & 3 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,18 @@ menu:
- name: Assignments
pageRef: /assignments
weight: 1
- name: Tutorials
pageRef: /tutorials
weight: 2
- name: Resources
pageRef: /additional-resources
weight: 2
- name: Search
weight: 3
- name: Search
weight: 4
params:
type: search
- name: GitHub
weight: 4
weight: 5
url: "https://github.com/ece-196"
params:
icon: github
Expand Down

0 comments on commit 36b1f34

Please sign in to comment.