Skip to main content

Tags

We structure our documents around tags. The documentation will provide collective summary pages for top-level chapters.

Convention​

info

Tags in this documentation follow the following guideline:

  • Written in kebab-case , e.g documentation, formatting etc.
  • Use singular form (if possible!).

All occurrences on this page like tag-a, tag-b denote tags.

Top-level tags for chapters are tagged in bold, e.g. chapter-a.

The following gives a summary of top-level tags which MUST be used together with other sub-tags which are not mandatory but help to structure content.

  • Development Practices dev-practice

    Contains topics as

    • Repository Guidelines repo-guideline: Covers the standard practices for managing code repositories.

      • Project Structure: repository-structure
      • Commit Conventions: commit-convention
      • Branching Models: branching-model
      • Common Settings (Code Scaffolding Tools and Templates): code-scaffolding, repository-template
      • Documentation Guidelines (README.md, CONTRIBUTION.md): documentation
      • Review Workflow (Code Quality): code-review, merge-request, merge, rebase

    • Language Guidelines language-guideline: Focuses on best practices for coding standards across different languages.

      • General for any language: programming
      • Python: python
      • Go: go
      • Rust: rust
      • TypeScript: typescript
      • Scala: scala
      • Nix: nix

      Each language should answer topics like:

      • Toolchain: toolchain

        What tools for formatting, linting, building, publishing are state of the art.

      Other topics:

  • Security and Privacy: security, privacy General principles and best practices to ensure the security and privacy of the application and its development process.

    • Signing and Encryption: gpg

  • Cloud Infrastructure and Deployment: cloud

    Guidelines and technologies related to cloud-based infrastructure and application deployment.

    • Kubernetes: kubernetes, k8
    • Providers: aws, gcp
    • Containerization: container, docker, podman
    • Virtualization: virtualization, vm

  • Developer Enablement and Tools dev-enablement

    • Setups: hardware-setup, computer-setup, work-setup
    • Hardware: hardware, computer, laptop
    • IDEs (e.g. ide, vscode, neovim, pycharm)
    • DevContainer: devcontainer
    • DevShells: devshell, nix
    • Shells: shell
    • Terminal terminal, terminal-multiplexer, terminal-tools
    • Package Manager package-manager
    • Systems: nixos
    • Version Control: git
    • Performance: performance, profiling, benchmarking

  • Automation: automation:

    • CI/CD: ci,cd
    • Workflow Managers workflow, workflow-manager

  • Machine Learning: ml, llm

  • Open-Source Software & Data: open-source-software, open-source-data

    • Copyright & Licence: open-source-license, copyright
    • Open-Research-Data: open-research-data
      • FAIR Principles: fair-principles

  • Design: ui-design, web-design, fonts

  • Visualisation: visualisation

    • Tools, frameworks, and guidelines for visualizing data and code outcomes, or improving user experience through visual tools.

  • Research:

    • Reproducibility reproducibility