Logo
1.0.0

Getting Started

  • Onboarding: Welcome to the SKA developer community
  • Contributing to the SKA
  • Configuring your development environment

Repositories

  • Projects by Area
  • List of projects and subgroups
  • Create a new project
  • Licensing a project

Development tools

  • Working with GitLab
  • Working with Jira
  • CI/CD
  • BDD testing guide
  • BDD Walkthrough
  • STFC: CI/CD & Testing Infrastructure
  • Containers: containerisation and deployment
  • BinderHub/JupyterHub
  • Documenting a project
  • Secret & Configuration Management
  • SKA Log Message Format
  • Centralised Monitoring, Logging & Debugging
  • Reporting and Management of Bugs
  • Coding guidelines
    • C++ Coding Guidelines
    • Javascript (JS) Guidelines
    • Python Coding Guidelines
    • Jupyter Notebook Coding Guidelines
    • Linting
  • Frequently Asked Questions
  • SKAO Binary Artefacts Repository (BAR)
  • Feature Flags

Tutorials

  • Database Integration
  • MongoDB Database Integration
  • PostgreSQL Database Integration
  • Feature Flags Tutorials
  • Feature Flags with Unleash Python SDK
  • Feature Flags with Static Configuration
  • Feature Flags with Tango Framework
  • Feature Flagging with Unleash React Proxy Client
  • Building a OCI Image
  • Setup Minikube for local development
  • Use Vaults secrets in Kubernetes
  • GitLab CI/CD Vault Integration
  • Automate the Release Process Using Templates

How-To Guides

  • Linting Ansible Projects
  • Code Review
  • Git Configuration
  • GitLab Configuration
  • Create work branch
  • Create merge request
  • Debugging with Coder
  • Deploying to Multiple SKAO Clusters
  • How to use VSCode Docker extension for Dockerfile development
  • Access and Browse Harbor
  • Linting Helm Charts
  • OCI Engine Installation Guide
  • Integrating CICD Makefile Submodule
  • Logging Solution
  • Monitoring Solution
  • Linting Notebooks
  • Linting OCI Projects
  • Building multiple OCI images
  • OCI Cache Priming - SKAO OCI Daemon
  • OCI Images Signature Management
  • Push code and branch
  • Linting Python Projects
  • Enable and Customise CI/CD Security Scanning
  • Guide to Sharing Storage Between Namespaces in SKAO Clusters
  • Linting Terraform
  • How to rotate secrets with Vault Secrets Operator and Kubernetes
  • How to use Vault to supply Helm values in GitLab CI/CD pipelines

References

  • Feature Flags Reference
  • Deploy Minikube Reference
  • Software Package Release References
  • Vault

Explanations

  • Branching policy
  • Central Artefact Repository
  • Committing code
  • Containerization and OCI Engines
  • Continuous Integration
  • Feature Flags
  • Linting
  • Merge request
  • Merge Request Quality Checks
  • OCI Supply Chain
  • Optimize OCI Image Builds
  • Policy Agent
  • Software Supply Chain
  • Kubernetes based Runners Architecture
  • Vault Structure

Policies and Procedures

  • SKA Code of Conduct
  • Fundamental SKA Software Standards
  • Software Product Quality Assurance Plan
  • Software Development Security Policy
  • SKAO Compute Access Policy
  • Definition of Done
  • Software Testing Policy and Strategy
  • SKA developer community decision making process
  • Incident Management

Recommended Reading

  • System Design
  • Programming
  • Programming Languages

About the SKA

  • The SKA Organisation
  • SAFe® for SKA
  • Follow us on social media
  • Agile teams and responsibilities

Contribute to the Developer Portal

  • Contribute to the developer portal
developer.skao.int
  • Coding guidelines
  • Edit on

Coding guidelines

  • C++ Coding Guidelines
  • Javascript (JS) Guidelines
  • Python Coding Guidelines
  • Jupyter Notebook Coding Guidelines
  • Linting
Previous Next

© Copyright 2018-2025 SKA Observatory.


This page was last updated on Apr 04, 2024.

SKA developer documentation by SKA Observatory is licensed under a Creative Commons Attribution 4.0 International License Creative Commons Licence

This work is inspired by the LSST developer guide © Copyright 2016-2018 Association of Universities for Research in Astronomy, licensed under a Creative Commons Attribution 4.0 International License.

This work is inspired by the Apache developer information Copyright © 2018 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.