Skip to content

[Exploration] docs: add Flox in Containers section#469

Draft
djsauble wants to merge 5 commits intomainfrom
docs/flox-in-containers
Draft

[Exploration] docs: add Flox in Containers section#469
djsauble wants to merge 5 commits intomainfrom
docs/flox-in-containers

Conversation

@djsauble
Copy link
Copy Markdown
Contributor

@djsauble djsauble commented Apr 6, 2026

Summary

  • Creates a new top-level "Flox in Containers" section that unifies all container-related docs
  • Adds Thin Containers docs (intro + getting started) for flox activate --sandbox and direct Docker/Podman usage
  • Adds Containerize docs (intro + getting started) consolidating flox containerize content into a discoverable guide
  • Migrates Imageless Kubernetes under the new section (no content changes, updated internal links)
  • Adds a shared "How it works" tech page explaining Nix store volumes, environment resolution, and the flox/empty base image
  • Frames flox containerize as the traditional/fallback approach, steering users toward thin containers and imageless K8s when possible
  • Adds cross-references from existing concept and tutorial pages

Nav structure

Flox in Containers
├── Introduction
├── How it works
├── Thin Containers
│   ├── Introduction
│   └── Getting started
├── Containerize
│   ├── Introduction
│   └── Getting started
└── Imageless Kubernetes
    ├── Introduction
    ├── Installation (EKS, Self-managed, Troubleshooting, Upgrading, Uninstall)
    ├── Examples
    └── Configuration

Test plan

  • Verify mkdocs builds cleanly with mkdocs serve
  • Verify all nav items render correctly
  • Verify no broken internal links (strict mode)
  • Verify existing Imageless K8s pages render at new paths
  • Review thin containers getting-started flow end-to-end
  • Review containerize getting-started flow end-to-end

🤖 Generated with Claude Code

…inerize docs

Restructure the docs to create a unified "Flox in Containers" top-level
section that houses all container approaches side by side:

- Thin Containers (new): local Docker/Podman sandboxing via
  `flox activate --sandbox` or direct `docker run` commands
- Containerize (new): consolidated guide for `flox containerize`,
  framed as the traditional fallback approach
- Imageless Kubernetes (migrated from top-level): production K8s
  workloads via containerd shim

Also adds a shared "How it works" tech page explaining the common
architecture (Nix store volumes, environment resolution, flox/empty
base image) and how it contrasts with traditional container images.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 6, 2026
- Update k8s/ redirect targets to point to containers/imageless-kubernetes/
- Add redirects from old imageless-kubernetes/ paths to new locations
- Fix remaining relative links in config.md, gitlab-ci.md, and install/ files
  that were off by one directory level after the move

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@djsauble djsauble changed the title docs: add Flox in Containers section [Exploration] docs: add Flox in Containers section Apr 6, 2026
@djsauble djsauble self-assigned this Apr 6, 2026
djsauble and others added 3 commits April 6, 2026 17:50
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Differentiates the Docker/Podman base image (flox/thin) from the
Imageless Kubernetes placeholder image (flox/empty). Also corrects
tech.md to document that the two approaches use different base images.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant