From fcff39631a6a23486ec61a910a7328cafdcd8aa4 Mon Sep 17 00:00:00 2001
From: Zixuan James Li <359101898@qq.com>
Date: Thu, 3 Mar 2022 17:21:27 -0500
Subject: [PATCH] Add documentation for COMPOSE_IGNORE_ORPHANS

Signed-off-by: Zixuan James Li <359101898@qq.com>
---
 docs/reference/compose.md          | 3 +++
 docs/reference/docker_compose.yaml | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/docs/reference/compose.md b/docs/reference/compose.md
index a3bba2985..3634d80c4 100644
--- a/docs/reference/compose.md
+++ b/docs/reference/compose.md
@@ -99,3 +99,6 @@ Setting the `COMPOSE_FILE` environment variable is equivalent to passing the `-f
 and so does `COMPOSE_PROFILES` environment variable for to the `--profiles` flag.
 
 If flags are explicitly set on command line, associated environment variable is ignored
+
+Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned 
+containers for the project.
diff --git a/docs/reference/docker_compose.yaml b/docs/reference/docker_compose.yaml
index 5f60611bc..02dc51216 100644
--- a/docs/reference/docker_compose.yaml
+++ b/docs/reference/docker_compose.yaml
@@ -98,6 +98,9 @@ long: |-
   and so does `COMPOSE_PROFILES` environment variable for to the `--profiles` flag.
 
   If flags are explicitly set on command line, associated environment variable is ignored
+  
+  Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
+  containers for the project.
 usage: docker compose
 pname: docker
 plink: docker.yaml