-
Notifications
You must be signed in to change notification settings - Fork 0
Deploy education directory to GitHub Pages #2
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: Deploy Education to GitHub Pages | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'education/**' | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: 'education' | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -14,6 +14,7 @@ The project is organized as a Cargo workspace with multiple crates: | |||||
| - `toppy-gw`: A lightweight QUIC + HTTP/3 gateway (QUIC ping + CONNECT-UDP echo/forward). | ||||||
| - `toppy-core`: Shared functionality, including configuration management, policy enforcement, and logging. | ||||||
| - `toppy-proto`: Definitions of the custom capsule/command messages used between client and gateway. | ||||||
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/)). | ||||||
|
||||||
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/)). | |
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/quiz_template_skeleton.html)). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||
| # Toppy Education | ||||||
|
|
||||||
| This directory contains educational materials for understanding Toppy, QUIC, HTTP/3, and CONNECT-UDP. | ||||||
|
|
||||||
| ## Available Resources | ||||||
|
|
||||||
| - **quiz_template_skeleton.html** - An interactive bilingual (EN/JP) quiz covering Toppy fundamentals, QUIC, HTTP/3, CONNECT-UDP, and architecture | ||||||
| - **quiz.css** - Styles for the quiz with light/dark theme support | ||||||
|
|
||||||
| ## GitHub Pages Deployment | ||||||
|
|
||||||
| These HTML files are automatically deployed to GitHub Pages when changes are pushed to the `main` branch. | ||||||
|
|
||||||
| Access the quiz at: `https://thinksyncs.github.io/toppy/quiz_template_skeleton.html` | ||||||
|
||||||
| Access the quiz at: `https://thinksyncs.github.io/toppy/quiz_template_skeleton.html` | |
| Access the quiz via GitHub Pages at a URL of the form `https://<owner>.github.io/<repo>/quiz_template_skeleton.html`. For this repository, that is `https://thinksyncs.github.io/toppy/quiz_template_skeleton.html`. When browsing the deployed site, you can also use the relative link `./quiz_template_skeleton.html`. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This list is introduced as “multiple crates”, but
educationis not a Cargo crate/module. Consider moving it to a separate “Other directories” list or explicitly labeling it as non-crate content to avoid confusing workspace structure.