BuildKit has been the default builder since Docker Engine 23.0 (Feb 2023),
so prefixing the example build commands with DOCKER_BUILDKIT=1 is redundant
on any supported install. Replace the prefix with an explicit prerequisite
note so the requirement lives with the user's environment, not the example.
The build relies on BuildKit secret mounts (--secret) to keep apps.json
tokens out of image layers, which is why a real BuildKit-default engine
is mandatory rather than merely recommended.
Addresses review feedback on PR #1861.
APPS_JSON_BASE64 is stored in image layer metadata, permanently exposing
private repo tokens (GitHub PATs) to anyone with image pull access.
Replace --build-arg with --mount=type=secret so that apps.json is only
available during the RUN step and never committed to any layer.
Refs: https://docs.docker.com/reference/build-checks/secrets-used-in-arg-or-env/
The README.md gives a brief overview about how to contribute to
documentation, and more detailed isntructions specific to VitePress is
added as a new page under References.
* docs: reorganize documentation structure into logical categories
Restructure documentation into organized directories for better navigation:
- getting-started/: Quick start guides for new users
- setup/: Setup and configuration guides
- production/: Production deployment guides (backup, TLS, multi-tenancy)
- operations/: Site operations and management
- development/: Development workflow guides
- migration/: Migration guides
- troubleshooting/: Troubleshooting guides
- reference/: Reference documentation (container setup, build configs)
Rename files for consistency:
- Use kebab-case naming convention throughout
- Remove numbered prefixes from container-setup files
- Use descriptive names (backup-strategy, tls-ssl-setup, etc.)
Update all internal cross-references to reflect new file locations.
Update README.md with organized documentation structure.
Fix image paths in development.md to use correct relative paths.
* docs: add numeric prefixes to directories and files for navigation order
Add numeric prefixes (01-08) to documentation directories to indicate
reading order and flow for first-time users:
- 01-getting-started: Quick start guides
- 02-setup: Setup and configuration
- 03-production: Production deployment
- 04-operations: Site operations
- 05-development: Development guides
- 06-migration: Migration guides
- 07-troubleshooting: Troubleshooting
- 08-reference: Reference documentation
Add numeric prefixes to files within directories to guide readers
through documentation in a logical sequence.
Update all cross-references throughout documentation to use new
numbered paths. Update README.md to reflect the new structure.
* docs: move container-setup to 02-setup and integrate setup-options content
Move container-setup directory from 08-reference/ to 02-setup/ to follow
PR feedback. The container-setup documentation provides a more linear
and coherent flow compared to the previous unstructured setup files.
Changes:
- Move container-setup/ from docs/08-reference/ to docs/02-setup/
- Integrate content from setup-options.md into structured flow:
- Create new 06-setup-examples.md with practical deployment scenarios
- Enhance 03-start-setup.md with site creation details from setup-options
- Remove redundant 01-setup-options.md (content now integrated)
- Rename 02-single-server-example.md to 07-single-server-example.md
- Update all cross-references throughout documentation:
- Update README.md with new structure under Setup section
- Fix links in site-operations.md and migration docs
- Add navigation links between container-setup files and examples
- Maintain container-setup's linear flow: overview → build → start → env → overrides
- Add practical examples document (06-setup-examples.md) that follows the container-setup guide
Result: Documentation now follows a clear progression from conceptual
overview through practical examples, with all setup information properly
organized under 02-setup/.
* docs: remove container-setup subfolder and flatten structure
Move all files from docs/02-setup/container-setup/ directly into docs/02-setup/
to eliminate unnecessary subfolder. Files are already numbered sequentially,
so they work perfectly at the same level.
Changes:
- Move all files from container-setup/ subfolder to 02-setup/ root
- Remove container-setup/ subfolder
- Update all cross-references:
- Update README.md paths (remove container-setup/ from all links)
- Fix references in site-operations.md
- Fix references in migration docs
- Update internal references in 06-setup-examples.md
- Fix relative path references in 01-overview.md, 02-build-setup.md, 03-start-setup.md
Result: Cleaner, flatter structure with all numbered setup files at the
same level, making navigation more straightforward.
* fix: Pre-commit failure is fixed
---------
Co-authored-by: adithya <adithya.a@bayesian.in>
