A Dev Container Template for Writing Scientific Work at IU International University using the LaTeX-Workshop Extension

Repo and Template Structure

This repository contains one Template - thesis. This Templates serves as a template implementation which forms the basis for writing a LaTeX paper. Similar to the devcontainers/templates repo, this repository has a src folder. Each Template has its own sub-folder, containing at least a devcontainer-template.json and .devcontainer/devcontainer.json.

├── src
│   └── thesis
│       ├── .devcontainer
│       │   └── devcontainer.json
│       ├── .gitignore
│       ├── README.md
│       ├── devcontainer-template.json
│       ├── images
│       │   ├── image.jpg
│       │   └── logo.png
│       ├── main.bib
│       └── main.tex
...

Options

All available options for a Template should be declared in the devcontainer-template.json. The syntax for the options property can be found in the devcontainer Template json properties reference.

An implementing tool will use the options property from the documented Dev Container Template properties for customizing the Template. See option resolution example for details.

Distributing Templates

Versioning

Templates are individually versioned by the version attribute in a Template's devcontainer-template.json. Templates are versioned according to the semver specification. More details can be found in the Dev Container Template specification.

Publishing

NOTE: The Distribution spec can be found here.

While any registry implementing the OCI Distribution spec can be used, this template will leverage GHCR (GitHub Container Registry) as the backing registry.

Templates are source files packaged together that encode configuration for a complete development environment.

This repo contains a GitHub Action workflow that will publish the template to GHCR. The Template in this repository can be referenced by an implementing tool with:

ghcr.io/torbenwetter/iu-latex-container-templates/thesis:latest

The provided GitHub Action will also publish a third "metadata" package with just the namespace, eg: ghcr.io/torbenwetter/iu-latex-container-templates. This contains information useful for tools aiding in Template discovery.

'torbenwetter/iu-latex-container-templates' is known as the template collection namespace.

Marking Template Public

For the Template to be used, it currently needs to be available publicly. By default, OCI Artifacts in GHCR are marked as private.

To make them public, navigate to the Template's "package settings" page in GHCR, and set the visibility to 'public`.

https://github.com/users/TorbenWetter/packages/container/iu-latex-container-templates%2Fthesis/settings

Adding the Template to the Index

Next you will need to add the Template to our public index so that other community members can find it. Just follow these steps:

• Go to github.com/devcontainers/devcontainers.github.io
  • This is the GitHub repo backing the containers.dev spec site
• Open a PR to modify the collection-index.yml file

This index is from where supporting tools like VS Code Dev Containers and GitHub Codespaces surface Templates for their Dev Container Creation Configuration UI.

Updating Documentation

This repo contains a GitHub Action workflow that will automatically generate documentation (ie. README.md) for the Template. This file will be auto-generated from the devcontainer-template.json and NOTES.md.