Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,416 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FCCAnalysesWeb

Source of the FCCAnalyses website, built with Hugo. Live at https://fccanalyses.web.cern.ch.

Building locally

hugo server -D

then open http://localhost:1313/. Hugo watches the content/, layouts/ and static/ directories and live-reloads the browser on changes.

To produce a production build:

hugo --gc --minify

Output is written to public/.

Structure

  • content/ — page content, in Markdown, one _index.md per page.
  • layouts/ — the nav/footer partials and page templates shared by every page (layouts/partials/header.html is the single source of the navigation bar, rather than duplicating it per page).
  • static/ — CSS, fonts and images, copied as-is into the built site.
  • hugo.toml — site configuration, including the navigation menu structure under [[menu.main]].

Some content — the Doxygen code reference, benchmarks, and the generated fccanalysis man pages — is not part of this repository. It continues to be built and published from the FCCAnalyses repository itself; this site links out to it where relevant.

Project space

The site is served from the fccanalyses CERNBox/EOS project space (/eos/project/f/fccanalyses, 1 TB quota), out of its pre-created www/ folder. The space also has a public/ folder, visible to all CERN-authenticated users, for anything that shouldn't go through the website build.

Access is controlled by three e-groups, managed via the CERN Groups Portal:

  • cernbox-project-fccanalyses-admins — full control, including sharing and managing the other groups.
  • cernbox-project-fccanalyses-writers — read, write and delete access.
  • cernbox-project-fccanalyses-readers — read-only access.

Group membership is the normal way to grant or revoke access.

Deployment

The site is deployed to CERN's EOS storage via a gitlab.cern.ch mirror of this repository, using ci-web-deployer in .gitlab-ci.yml, which authenticates as the fccanalyses service account — a dedicated account, rather than a personal one. Besides EOS_PATH (/eos/project/f/fccanalyses/www, set directly in .gitlab-ci.yml), the pipeline needs these set as CI/CD variables on the gitlab.cern.ch project (Settings → CI/CD → Variables):

  • EOS_ACCOUNT_USERNAMEfccanalyses
  • EOS_ACCOUNT_PASSWORD — its password (masked and protected)
  • EOS_MGM_URLroot://eosproject.cern.ch, the EOS instance for project spaces (/eos/project/...), as opposed to ci-web-deployer's default of eosuser.cern.ch, which is for personal EOS spaces

For ci-web-deployer's writes to succeed, the fccanalyses account needs both membership in the writers group above and a direct CERNBox share of the www/ folder with writers — group membership alone is not sufficient.

Writing files into www/ on its own does not make them reachable, either — CERN's WebEOS hosting requires a separate, one-time site registration via the Web Services Portal, mapping a chosen site name to the EOS path containing the index file. This site is registered as fccanalyses, giving the https://fccanalyses.web.cern.ch URL above. New sites default to requiring CERN SSO login; this one was switched to public access in the site's settings so it's reachable without authenticating.

License

This repository is licensed file-by-file, following REUSE conventions:

  • Code (layouts/, static/css/, hugo.toml, .gitlab-ci.yml, .gitignore, .zenodo.json) is licensed under Apache-2.0.
  • Page content (content/) and this README are licensed under CC-BY-4.0, per CERN OSPO's recommendation for documentation.
  • The Space Mono font (static/font/SpaceMono-Regular.woff2) is licensed under OFL-1.1.
  • The Roobert font (static/font/Roobert-*) is a commercial typeface from Displaay Type Foundry and the CERN/FCC logo and favicon (static/img/) are CERN branding assets — neither is covered by this repository's open licenses; see LICENSES/LicenseRef-*.txt.

See REUSE.toml and LICENSES/ for the exact per-file licensing and full license texts. The top-level LICENSE file (Apache-2.0) is kept for tooling that only reads a single license.

About

Source of the FCCAnalyses website, built with Hugo

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages