From 71cd07173bdf92e557816b6bda2914b3f1ca078b Mon Sep 17 00:00:00 2001 From: 0x1B40 Date: Wed, 29 Oct 2025 14:33:32 +0300 Subject: [PATCH] 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. --- README.md | 10 +++++----- docs/02-setup/{container-setup => }/01-overview.md | 2 +- docs/02-setup/{container-setup => }/02-build-setup.md | 2 +- docs/02-setup/{container-setup => }/03-start-setup.md | 2 +- .../02-setup/{container-setup => }/04-env-variables.md | 0 docs/02-setup/{container-setup => }/05-overrides.md | 0 docs/02-setup/06-setup-examples.md | 8 ++++---- docs/04-operations/01-site-operations.md | 2 +- docs/06-migration/01-migrate-from-multi-image-setup.md | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) rename docs/02-setup/{container-setup => }/01-overview.md (98%) rename docs/02-setup/{container-setup => }/02-build-setup.md (98%) rename docs/02-setup/{container-setup => }/03-start-setup.md (97%) rename docs/02-setup/{container-setup => }/04-env-variables.md (100%) rename docs/02-setup/{container-setup => }/05-overrides.md (100%) diff --git a/README.md b/README.md index 158cbbff..1296dd5d 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,11 @@ If you ran in a Dev Docker environment, to view container logs: `docker compose ### [Setup](#setup) -- [Container Setup Overview](docs/02-setup/container-setup/01-overview.md) -- [Build Setup](docs/02-setup/container-setup/02-build-setup.md) -- [Start Setup](docs/02-setup/container-setup/03-start-setup.md) -- [Environment Variables](docs/02-setup/container-setup/04-env-variables.md) -- [Compose Overrides](docs/02-setup/container-setup/05-overrides.md) +- [Container Setup Overview](docs/02-setup/01-overview.md) +- [Build Setup](docs/02-setup/02-build-setup.md) +- [Start Setup](docs/02-setup/03-start-setup.md) +- [Environment Variables](docs/02-setup/04-env-variables.md) +- [Compose Overrides](docs/02-setup/05-overrides.md) - [Setup Examples](docs/02-setup/06-setup-examples.md) - [Single Server Example](docs/02-setup/07-single-server-example.md) diff --git a/docs/02-setup/container-setup/01-overview.md b/docs/02-setup/01-overview.md similarity index 98% rename from docs/02-setup/container-setup/01-overview.md rename to docs/02-setup/01-overview.md index b3582941..08f3d233 100644 --- a/docs/02-setup/container-setup/01-overview.md +++ b/docs/02-setup/01-overview.md @@ -46,4 +46,4 @@ Example: The main compose file has no database service, but `compose.mariadb.yam **Next:** [Build Setup →](02-build-setup.md) -**See also:** [Setup Examples](../06-setup-examples.md) for practical deployment scenarios. +**See also:** [Setup Examples](06-setup-examples.md) for practical deployment scenarios. diff --git a/docs/02-setup/container-setup/02-build-setup.md b/docs/02-setup/02-build-setup.md similarity index 98% rename from docs/02-setup/container-setup/02-build-setup.md rename to docs/02-setup/02-build-setup.md index fa50b083..ace05f49 100644 --- a/docs/02-setup/container-setup/02-build-setup.md +++ b/docs/02-setup/02-build-setup.md @@ -120,4 +120,4 @@ This generates `compose.custom.yaml`, which you'll use to start all containers. **Back:** [Container Overview ←](01-overview.md) -**See also:** [Setup Examples](../06-setup-examples.md) for practical deployment scenarios. +**See also:** [Setup Examples](06-setup-examples.md) for practical deployment scenarios. diff --git a/docs/02-setup/container-setup/03-start-setup.md b/docs/02-setup/03-start-setup.md similarity index 97% rename from docs/02-setup/container-setup/03-start-setup.md rename to docs/02-setup/03-start-setup.md index 6d2e98e1..53dba44c 100644 --- a/docs/02-setup/container-setup/03-start-setup.md +++ b/docs/02-setup/03-start-setup.md @@ -59,4 +59,4 @@ For more site operations, refer to [site operations](../../04-operations/01-site **Back:** [Build Setup →](02-build-setup.md) -**Next:** [Setup Examples →](../06-setup-examples.md) +**Next:** [Setup Examples →](06-setup-examples.md) diff --git a/docs/02-setup/container-setup/04-env-variables.md b/docs/02-setup/04-env-variables.md similarity index 100% rename from docs/02-setup/container-setup/04-env-variables.md rename to docs/02-setup/04-env-variables.md diff --git a/docs/02-setup/container-setup/05-overrides.md b/docs/02-setup/05-overrides.md similarity index 100% rename from docs/02-setup/container-setup/05-overrides.md rename to docs/02-setup/05-overrides.md diff --git a/docs/02-setup/06-setup-examples.md b/docs/02-setup/06-setup-examples.md index e86ba898..1ba3d578 100644 --- a/docs/02-setup/06-setup-examples.md +++ b/docs/02-setup/06-setup-examples.md @@ -1,6 +1,6 @@ # Setup Examples -This guide provides practical examples for common setup scenarios. These examples build upon the [container setup guide](container-setup/01-overview.md) and demonstrate how to combine the base compose file with overrides. +This guide provides practical examples for common setup scenarios. These examples build upon the [container setup guide](01-overview.md) and demonstrate how to combine the base compose file with overrides. > **Note:** This setup is not for development. A complete development environment is available [here](../05-development/01-development.md). @@ -18,7 +18,7 @@ Copy the example docker environment file to `.env`: cp example.env .env ``` -Edit `.env` and set variables according to your needs. See [environment variables](container-setup/04-env-variables.md) for detailed descriptions of all available variables. +Edit `.env` and set variables according to your needs. See [environment variables](04-env-variables.md) for detailed descriptions of all available variables. ## Storing Generated YAML Files @@ -90,7 +90,7 @@ docker compose -f compose.yaml \ docker compose --project-name -f ~/gitops/docker-compose.yml up -d ``` -> **Note:** Ensure your `SITES` variable is properly formatted. See [environment variables](container-setup/04-env-variables.md) for the correct format. +> **Note:** Ensure your `SITES` variable is properly formatted. See [environment variables](04-env-variables.md) for the correct format. ## Create First Site @@ -129,7 +129,7 @@ To migrate sites after updating, refer to [site operations](../04-operations/01- --- -**Back:** [Start Setup →](container-setup/03-start-setup.md) +**Back:** [Start Setup →](03-start-setup.md) **Next:** [Single Server Example →](07-single-server-example.md) diff --git a/docs/04-operations/01-site-operations.md b/docs/04-operations/01-site-operations.md index b3235ab9..1520d6aa 100644 --- a/docs/04-operations/01-site-operations.md +++ b/docs/04-operations/01-site-operations.md @@ -15,7 +15,7 @@ docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --d If you need to install some app, specify `--install-app`. To see all options, just run `bench new-site --help`. -To create Postgres site (assuming you already use [Postgres compose override](../02-setup/container-setup/05-overrides.md)) you need have to do set `root_login` and `root_password` in common config before that: +To create Postgres site (assuming you already use [Postgres compose override](../02-setup/05-overrides.md)) you need have to do set `root_login` and `root_password` in common config before that: ```sh docker-compose exec backend bench set-config -g root_login diff --git a/docs/06-migration/01-migrate-from-multi-image-setup.md b/docs/06-migration/01-migrate-from-multi-image-setup.md index 093667a6..77202e0f 100644 --- a/docs/06-migration/01-migrate-from-multi-image-setup.md +++ b/docs/06-migration/01-migrate-from-multi-image-setup.md @@ -6,7 +6,7 @@ Now you need to specify command and environment variables for following containe ### Frontend -For `frontend` service to act as static assets frontend and reverse proxy, you need to pass `nginx-entrypoint.sh` as container `command` and `BACKEND` and `SOCKETIO` environment variables pointing `{host}:{port}` for gunicorn and websocket services. Check [environment variables](../02-setup/container-setup/04-env-variables.md) +For `frontend` service to act as static assets frontend and reverse proxy, you need to pass `nginx-entrypoint.sh` as container `command` and `BACKEND` and `SOCKETIO` environment variables pointing `{host}:{port}` for gunicorn and websocket services. Check [environment variables](../02-setup/04-env-variables.md) Now you only need to mount the `sites` volume at location `/home/frappe/frappe-bench/sites`. No need for `assets` volume and asset population script or steps.