From a8b37b00f1e1b36e04fb681edcf5029ff2b1a67d Mon Sep 17 00:00:00 2001 From: Kesara Rathnayake Date: Wed, 29 Nov 2023 07:17:03 +1300 Subject: [PATCH] docs: Update sandbox naming logic (#349) * docs: Update sandbox naming logic * docs: Update README.md --------- Co-authored-by: Nicolas Giard --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c60ba1c..3261d7b3 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,6 @@ Dev _(automatically build from **main** branch)_: https://ws-main.dev.ietf.org/ * Tick **Deploy to Sandbox**. * Click **Run Workflow** button. -If main branch is selected, changes will be deployed to https://ws-main.dev.ietf.org/ +If the `main` branch is selected, changes will be deployed to https://ws-main.dev.ietf.org/ -If any other branch is selected changes will be available on a subdomain compiled from the branch name. For example, deployment from `feat/foobar` branch will be available on `https://ws-feat-foobar.dev.ietf.org`. +Changes will be available on a subdomain compiled from the branch name if any other branch is selected. If a `/` is present in the branch name, the first part will be stripped off and any other `/` are replaced with `-`. For example, deployment from the `feat/foobar` branch will be available on `https://ws-foobar.dev.ietf.org`, branch `fix/foo-bar` will be available on `https://ws-foo-bar.dev.ietf.org` and branch `fix/foo/bar` will be available on `https://ws-foo-bar.dev.ietf.org`.