Welcome to HERMES-SOC Docker Base Image documentation!

This is the documentation for the Base Image that will be used throughout the different .devcontainer repositories as well as the base image for the Lambda Processing function within the file processing pipeline. The image is built, tested and deployed automatically through a CI/CD Pipeline allowing anyone to make changes to the base image that lives in the public ECR repo. This documentation is intended to be used by developers who are interested in contributing to the project as well as those who’d like to know more about the project. The documentation is written in reStructuredText and built using Sphinx.

To learn more about contributing to the project, please see the Developers Guide <dev-guide/index> section.

If you’d like to know more about the project, please visit the project’s GitHub repository page.

Contents:

• Developer’s Guide
  • Setting Up a Development Environment
  • Following Code Standard and Style Guidelines
  • Testing and Continuous Integration
  • Documentation Maintenance
  • Maintainer Workflow
    • Developer Environment
      • Understanding the Basics
      • Setting Up Your Development Environment
    • Workflow for Maintainers
      • Integrating changes via the web interface (recommended)
        • When to remove or combine/squash commits
        • When to rebase
        • A few commits
        • A long series of commits
        • Check the history
        • Push to open pull request
      • IOssue Milestones and Labels
      • Updating and Maintaining the Changelog
      • Releases
    • Coding Standards
      • Language Standard
      • Coding Style/Conventions
      • Testing
        • Automate
        • By Hand
      • Documentation
    • Documentation Rules
      • Overview
        • Referring to other code
        • Project-specific Rules
      • Sphinx
        • Usage and Building the documentation
          • HTML
          • PDF
    • CI/CD Pipeline and Testing Guidelines
      • Writing tests
        • Where to put tests
        • schemaVersion
        • commandTests
        • fileExistenceTests
        • More options available
        • Bugs Testing
      • CI/CD Pipeline
        • Pull Request Pipeline
        • Merge Pipeline
        • Diagram of Full CI/CD Pipeline
        • Manually initiating the CI/CD Pipeline
• User’s Guide
  • Dockerfile Guide
    • What is Docker
    • What is a Dockerfile
    • Structure of a Dockerfile
    • Common Docker Commands
    • Tips When Making Changes
      • Order Matters
      • Rebuilding the Image
      • Add Container Tests
      • Add Python Packages via the requirements
  • Python Package Guide
    • What is a Python Package
    • How to add a Package to the Base Image
    • To Verify the Package is Installed