Hugo Frontmatter

First step on every new repo!

  • Due to the nature of Open source software, sometimes there are breaking changes. In this instance, Hugo has deprecated usage of the config.toml file in favor of a new file named Hugo.toml
  • Additionally, as part of the upgrade, we needed to modify some parameters in the file, so we took the opportunity to use a Jinaj2 template to generate the file for with proper parameters
    • This also allows us the ability to update the template in the future and re-generate hugo.toml as necessary
    • Rather than modify Hugo.toml directly, we will now maintain a JSON configuration file /scripts/repoConfig.json
  • TLDR Update scripts/repoConfig.json with parameters for your workshop
  • Every time the container runs it first executes a script generate_toml which will generate the hugo.toml file
    • Change you will no longer see config.toml or hugo.toml in your repo! It’s created automatically for you, and only exists while the container is running.

example of repoConfig.toml. Replace each value with specific parameters for your repo prior to using the generate_toml script:

  • repoName (your repo name from GitHub)
  • author
  • Workshop Title
  • themeVariant (options: [“Workshop”, “Demo”, “UseCase”, “Spotlight”, “Xperts2024, Xperts2025”] )
  • logoBannerText (whatever you want in top left Menu under Fortinet Logo. Leaving this field blank will default to the themeVariant name)
  • logoBannerSub Text (optional sub-banner text)
  • marketingCode (optional marketing code to be used as default in analytics gathering and provisioning form)
  • bannerLine1 (optional text for XPerts Content Header banner line 1)
  • bannerLine2 (optional text for XPerts Content Header banner line 2)
  • bannerLine3 (optional text for XPerts Content Header banner line 3)
  • Shortcuts (Helpful Resources Links in the left menu
  • DO NOT CHANGE THE FOLLOWING:
    • errorLevel
    • googleServicesID
{
  "repoName":"UserRepo",
  "author":"CSE Employee",
  "workshopTitle":"Hugo for Fortinet TECWorkshops",
  "themeVariant":"Xperts2025",
  "logoBannerText":"",
  "logoBannerSubText":"",
  "errorLevel":"warning",
  "googleServicesID":"G-5RZBH288ST",
  "marketingCode": "MGO12345",
  "bannerLine1":"Workshop Type ID Eg: Public Cloud 101",
  "bannerLine2":"Workshop Title Here",
  "bannerLine3":"Subtitle,Description, or 3rd line Here",
  "shortcuts": [
  {
    "text": "Fortinet Cloud CSE GitHub Org",
    "URL": "https://github.com/FortinetCloudCSE",
    "icon": "fa-graduation-cap",
    "weight":10
  },
  {
    "text": "Fortinet Standard Workshop Guide",
    "URL": "https://fortinetcloudcse.github.io/UserRepo",
    "icon": "fa-tools",
    "weight":20
  },
  {
    "text": "Fortinet Standard Workshop Template Repo",
    "URL": "https://github.com/FortinetCloudCSE/UserRepo",
    "icon": "fa-tools",
    "weight":30
  },
  {
    "text": "Fortinet Hugo reLearn theme - Guide",
    "URL": "https://mcshelby.github.io/hugo-theme-relearn/index.html",
    "icon": "fa-tools",
    "weight":40
  }
  ]
}