Website

This repository contains the Antora playbook and the GitHub actions needed to build and publish the website

Structure

The content for each language's site is constructed from multiple components managed in the following repositories:

• www (this repository) contains the antora-playbook files for each language which describe how each language's site should be built and from which components. It also provides some additional html, javascript and css in the supplemental-ui directory which override the default content for all the sites.
• Website-UI is used to create an antora ui-bundle.zip for each language - this defines the html,css and javascript used for each site
• Website-Home-Section provides a landing paged for each language and any other non-course related content
• cti-documentation contains the course materials with different course-versions stored in different branches
• Website-Course-Template provides a template for making new courses

The diagram below visualizes how content from each repository is combined for the en (English) language site but the method is the same for the es (Spanish), fr (French), zh (Chinese) sites.

flowchart TB
    subgraph www["`📚 www (this repo)`"]
        en-antora-playbook["📜 antora-playbook-en.yml"] ---|An update to the dependency-repositories will trigger this action| github-www-build[🛠️ github-action]
    end
    subgraph website-ui["`📚 <a href='https://github.com/LabVIEWCommunityTraining/website-ui'>Website-UI</a>`"]
        en-ui["📂 en"]---github-bundle-build[🛠️ github-action]
    end
    subgraph website-home["📚 <a href='https://github.com/LabVIEWCommunityTraining/website-home-section'>Website-Home-Section</a>"]
        en-hs["📂 en"]-->en-antora-playbook
    end
    subgraph cti-docs["`📚 <a href='https://github.com/LabVIEWCommunityTraining/cti-documentation'>cti-documentation</a>`"]
        subgraph cti-docs-v1["🌿 V1.0"]
            en-conv1(📂www/en)-->en-antora-playbook
        end
        subgraph cti-docs-v2["🌿 V2.0"]
            en-conv2(📂www/en)-->en-antora-playbook
        end
    end
    subgraph website-template["`📚 <a href='https://github.com/LabVIEWCommunityTraining/website-course-template'>Website-Course-Template</a>`"]
        subgraph wt-v1["🌿 V1.0"]
            en-templatev1(📂www/en)-->en-antora-playbook
        end
    end
    github-bundle-build --> en-ui-bundle["📦 en/ui-bundle.zip"]-->en-antora-playbook
    en-output["🌐 www/en"]
    github-www-build --> en-output
    style github-www-build stroke-width:0px
    style github-bundle-build stroke-width:0px
    

Loading

(key: 📚 repository, 📂 folder, 🌿 git-branch, 📦 zip-file, 🌐 published-site, 📜 script, 🛠️ automation)