- HTML 77.2%
- Ruby 12.2%
- SCSS 10.6%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .well-known | ||
| _archive | ||
| _change-dossiers | ||
| _cookbooks | ||
| _data | ||
| _includes/head | ||
| _layouts | ||
| _pages | ||
| _posts | ||
| _sass | ||
| _specifications | ||
| assets | ||
| .gitignore | ||
| 404.html | ||
| _config.yml | ||
| Gemfile | ||
| README.md | ||
swiyu-admin-ch.github.io
Technical documentation repository for the swiyu Public Beta Trust Infrastructure
Overview
The aim of this repository is to provide a technical overview, deeper insights on standards and protocols as well as cookbooks for the onboarding to the different components of the swiyu Public Beta Trust Infrastructure. The content in this repository will be automatically published on the swiyu documentation website. The website offers better user guidance and additional features compared to the Git Hub repository.
The structure of the documentation website covers the following topics:
- Overview of the Swiss Trust Infrastructure
- Selected base technologies and supported technical standards
- Open Source components: Overview and links to the code repositories
- Cookbooks for onboarding the different stakeholders
- Specifications of the "Swiss Profiles", Trust Protocol, and other standards
- Threat Model of the swiyu Trust Infrastructure
- Roadmap with the current stage and gaps of Public Beta
- Footer with links to release announcements and our community repository
Public Beta
All documentation is related to the Public Beta environment and is not complete. The content reflects the current state of implementation and will evolve in the future to fullfil the requirements of the swiyu Trust Infrastructure. As soon as we'll have different versions e.g. for Public Beta and the Pre-release environment, the versions will be marked. Please note that operation and support of the Public Beta environment are run on a best effort basis.
Basic repository structure
The structure of the repository is different from the website.
- _cookbooks: The cookbooks are a collection of markdown files you'll find in this folder.
- _data: In this folder you'll find the basic navigation as well as all translations for the user interface
- _pages: Most of the webpages are markdown files in the _pages folder.
- _posts: All posts for the release announcements are markdown files in the _posts folder.
- _specifications: Specific specifications and implementations for the swiyu Public Beta Trust Infrastructure
- assets: All relevant assets for the website, e.g. images for the general appearance and cookbooks, are placed in sub-folders
"Live" browsing
The website generated by Jekyll can also be browsed "live" during the development. Here is a short Docker-based example:
# For available versions, visit https://hub.docker.com/r/jekyll/jekyll/tags
export JEKYLL_VERSION=latest
# Build the site
docker run --rm -it --volume="$PWD:/srv/jekyll" jekyll/jekyll:${JEKYLL_VERSION} jekyll build
# "Serve" the site
docker run --rm -it --volume="$PWD:/srv/jekyll" -p 8080:4000 jekyll/jekyll:${JEKYLL_VERSION} jekyll serve --watch --drafts
# ...
# Server running... press ctrl-c to stop.
# To browse the generated site, visit http://localhost:8080
Contributions and feedback
Contributions related to the documentation website are welcome via GitHub issues and pull requests. Before opening an issue or pull request, please check whether a ticket already exists that describes your intention. Our status board provides you with an overview of the status of your enquiry.
If you have general questions about the technical aspects, please start a discussion.
Kudos
The swiyu docs website is built with Jekyll. As template, we use the Minimal Mistake theme by Michael Rose.