Skip to content

Commit 6fcd1c6

Browse files
OlivierJourdanOlivierJourdan
authored
Initial commit
0 parents  commit 6fcd1c6

34 files changed

+255
-0
lines changed

‎.github/workflows/trigger-website-publishing.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Trigger Target Workflow
2+
3+
on:
4+
push:
5+
# Allows you to run this workflow manually from the Actions tab
6+
workflow_dispatch:
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
trigger:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Trigger Workflow in Another Repository
20+
run: |
21+
repo_owner="LabVIEWCommunityTraining"
22+
repo_name="www"
23+
workflow_file="publish-website-on-gh-pages.yml"
24+
branch="main"
25+
json_data="{\"ref\": \"$branch\"}"
26+
curl -L \
27+
-X POST \
28+
-H "Accept: application/vnd.github+json" \
29+
-H "Authorization: Bearer ${{ secrets.WEBSITE_DELIVERY_TRIGGER }}" \
30+
-H "X-GitHub-Api-Version: 2022-11-28" \
31+
https://api.github.com/repos/$repo_owner/$repo_name/actions/workflows/$workflow_file/dispatches \
32+
-d "$json_data"
33+
34+
publish_zip:
35+
runs-on: ubuntu-latest
36+
needs: [] # Run in parallel
37+
steps:
38+
- name: Checkout repository
39+
uses: actions/checkout@v4
40+
41+
- name: Zip course-material
42+
run: |
43+
cd course-material
44+
zip -r ../course-material.zip .
45+
cd ..
46+
47+
- name: Move zip to _public folder
48+
run: |
49+
mkdir -p _public
50+
mv course-material.zip _public/
51+
52+
# download UIs
53+
- name: Upload GitHub Pages Artifact
54+
uses: actions/upload-pages-artifact@v3
55+
with:
56+
path: _public
57+
- name: Deploy to GitHub Pages
58+
id: deployment
59+
uses: actions/deploy-pages@v4

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 LabVIEWCommunityTraining
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
= Website Course Template
2+
3+
This repository is the starting point for a new CTI course.
4+
5+
Instruction to create a new course are available https://labviewcommunitytraining.github.io/www/en/new-course.html[here].

‎_public/index.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Course material</title>
6+
</head>
7+
<body>
8+
<h1>Note</h1>
9+
<p>This site is providing course material for the CTI website. It is not dedicated for human visitors.</p>
10+
</body>
11+
</html>

‎course-material/README.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
= Course material folder
2+
3+
This folder is intended to gather all files needed to take the course:
4+
- LabVIEW code exercices and solutions
5+
- Data files
6+
- …
7+
8+
NOTE: Each time you push a modification to this folder, a zip file is created that can be downloaded from the course overview section.

‎www/en/antora.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: template-course
2+
title: Template course
3+
version: true
4+
# uncomment the prerelease: attribute when you want the version to be set as prerelease
5+
# prerelease: -beta
6+
nav:
7+
- modules/ROOT/nav.adoc
8+
asciidoc:
9+
attributes:

‎www/en/modules/ROOT/images/.gitkeep

Whitespace-only changes.

‎www/en/modules/ROOT/nav.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
* xref:index.adoc[Overview]
2+
* xref:set-up.adoc[Set-up Instructions]
3+
* xref:lesson-1.adoc[Lesson 1]
4+
* xref:lesson-2.adoc[Lesson 2]

‎www/en/modules/ROOT/pages/index.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
= Course overview
2+
3+
In this section, add:
4+
5+
- an overview of the content
6+
- the goals
7+
- the people targeted
8+
- the prerequisite knowledge
9+
- the recommended courses to take before and after
10+
11+
NOTE: This page is the entry point of the course.
12+
13+
== Download
14+
15+
// do not include the PDF download link in the PDF itself. See
16+
17+
ifeval::["{backend}" != "pdf"]
18+
* {site-url}/{page-component-name}/{page-component-version}/{page-component-name}.pdf[PDF version of the course]
19+
endif::[]

0 commit comments

Comments
 (0)