From f4a94cceefdecf168ffa38a1fbbc49a649c4da51 Mon Sep 17 00:00:00 2001 From: Armin Stross-Radschinski Date: Wed, 29 Jan 2025 22:23:05 +0100 Subject: [PATCH 1/2] Update deploy.md add hints on restrictions on availability of Environments and how to find explicit values in the README Further improvements This can be cross linked to the creation of the repo, where I suggested a similar hint. --- docs/plone-deployment/deploy.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/plone-deployment/deploy.md b/docs/plone-deployment/deploy.md index 462e321b..1d0c4ee8 100644 --- a/docs/plone-deployment/deploy.md +++ b/docs/plone-deployment/deploy.md @@ -102,12 +102,19 @@ Monitor the logs of each service with these commands: #### Creating a New Environment +````{important} +When you cannot see the Environment option on the left in the Settings of your Github repo, you may have a private repo in a free account. You either need to use a public repo in a free account or upgrade to at least Github Pro. If you use a free additional organisation under control of a payed accout, the Environment is also not visible in the above situation. +```` + 1. Log in to [GitHub](https://github.com/). 2. Navigate to the project repository. 3. Click `Settings`. 4. Select `Environments`, then `New environment`. -5. Name it after your public URL and configure the environment. +5. Name it after the public URL of the deployment server and configure the environment. +````{important} +**Tip:** You find exlicit instructions which values to fill into these fields for your particular project in the provided `devops/README-GHA.md` file +```` #### Adding Environment Secrets Add secrets in the `Secrets` section of your environment. Refer to the table below: From 92e7a8bd35b081e01f56c6902197ec8bd1b0710c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 30 Jan 2025 05:03:02 -0800 Subject: [PATCH 2/2] Apply suggestions from code review --- docs/plone-deployment/deploy.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/plone-deployment/deploy.md b/docs/plone-deployment/deploy.md index 1d0c4ee8..1e30a761 100644 --- a/docs/plone-deployment/deploy.md +++ b/docs/plone-deployment/deploy.md @@ -102,9 +102,11 @@ Monitor the logs of each service with these commands: #### Creating a New Environment -````{important} -When you cannot see the Environment option on the left in the Settings of your Github repo, you may have a private repo in a free account. You either need to use a public repo in a free account or upgrade to at least Github Pro. If you use a free additional organisation under control of a payed accout, the Environment is also not visible in the above situation. -```` +```{important} +If you can't see the {guilabel}`Environment` option on the left in the {guilabel}`Settings` of your GitHub repository, you may have a private repository in a free account. +You must either have a public repository or a [GitHub Team plan](https://github.com/pricing#compare-features) for a private repository. +If you use a free additional organization under control of a paid GitHub account, the {guilabel}`Environment` will also not be visible. +``` 1. Log in to [GitHub](https://github.com/). 2. Navigate to the project repository. @@ -112,9 +114,10 @@ When you cannot see the Environment option on the left in the Settings of your G 4. Select `Environments`, then `New environment`. 5. Name it after the public URL of the deployment server and configure the environment. -````{important} -**Tip:** You find exlicit instructions which values to fill into these fields for your particular project in the provided `devops/README-GHA.md` file -```` +```{seealso} +In the generated project's file {file}`devops/README-GHA.md`, you can find the exact values to use for your project when completing the {guilabel}`New environment` form. +``` + #### Adding Environment Secrets Add secrets in the `Secrets` section of your environment. Refer to the table below: