From 897e6a6630807652292bc56fb73eeae80f386cc9 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 11:43:42 +0000 Subject: [PATCH 01/15] Fixing broken link --- src/shared-content/teamcity/teamcity-pack.include.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/shared-content/teamcity/teamcity-pack.include.md b/src/shared-content/teamcity/teamcity-pack.include.md index 8ed75f347f..075a7d99c8 100644 --- a/src/shared-content/teamcity/teamcity-pack.include.md +++ b/src/shared-content/teamcity/teamcity-pack.include.md @@ -2,7 +2,7 @@ Octopus supports multiple [package formats](/docs/packaging-applications/#supported-formats) for deploying your software. TeamCity can be configured to monitor your source control and package your applications when changes are made. -You configure TeamCity to package your applications by creating a [build configuration](https://www.jetbrains.com/help/teamcity/build-configuration.html), and adding a step to the configuration of runner type, **Octopus Deploy: Pack**. +You configure TeamCity to package your applications by creating a [build configuration](https://www.jetbrains.com/help/teamcity/creating-and-editing-build-configurations.html), and adding a step to the configuration of runner type, **Octopus Deploy: Pack**. 1. Give the step a name. 2. Enter the [package ID](/docs/packaging-applications/#package-id). From ca35922cad58538deca2d3491d7be496088ff6cc Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 11:53:00 +0000 Subject: [PATCH 02/15] Fixing broken link --- src/pages/docs/deployments/custom-scripts/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/deployments/custom-scripts/index.md b/src/pages/docs/deployments/custom-scripts/index.md index 98d8e861aa..108cbc2d95 100644 --- a/src/pages/docs/deployments/custom-scripts/index.md +++ b/src/pages/docs/deployments/custom-scripts/index.md @@ -94,7 +94,7 @@ Learn about [script integrity](/docs/security/script-integrity). We recommend the following approaches for developing and testing your scripts, in order of preference: - 1. Build your script to use script arguments as inputs so it can be invoked with equal fidelity from Octopus or directly in your development environment. You can test your scripts by invoking them directly in a development environment with a very fast feedback cycle. Learn about [passing parameters to scripts](passing-parameters-to-scripts/). The only difference in this approach may be the user context the script runs in. + 1. Build your script to use script arguments as inputs so it can be invoked with equal fidelity from Octopus or directly in your development environment. You can test your scripts by invoking them directly in a development environment with a very fast feedback cycle. Learn about [passing parameters to scripts](/docs/deployments/custom-scripts/passing-parameters-to-scripts). The only difference in this approach may be the user context the script runs in. 2. Build your script as a reusable step template and test it using the `Run Now` feature. [Learn about step templates](/docs/projects/custom-step-templates). The only difference to this approach is the absence of deployment-specific variables provided by Octopus when actually running a deployment. 3. Put your script in a test process and run that process in a test environment. 4. Put your script in a real process and run that process in a test environment. From 0f6a2be75941be617eee2121925d5c7e5a4c3561 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 11:56:40 +0000 Subject: [PATCH 03/15] Removing broken links --- .../deployments/custom-scripts/scripts-in-packages/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md b/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md index 346d37d63b..5ff6fdc970 100644 --- a/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md +++ b/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md @@ -59,7 +59,7 @@ However, not all package steps support script hooks. As a general rule, any of t ## Running a script when a step fails -You can create a file named `DeployFailed.`, which will be invoked if the step fails. Our blog post about this feature [describes how DeployFailed. works](https://octopus.com/blog/deployfailed). +You can create a file named `DeployFailed.`, which will be invoked if the step fails. ## How Octopus executes your scripts @@ -115,4 +115,4 @@ If you are using OctoPack to package a Windows Service or console application, s Read more about [using OctoPack](/docs/packaging-applications/create-packages/octopack). -If the scripts in your package are still not running, make sure someone has not set a project variable called `Octopus.Action.Package.RunScripts` to `false` for the step where the scripts should run. \ No newline at end of file +If the scripts in your package are still not running, make sure someone has not set a project variable called `Octopus.Action.Package.RunScripts` to `false` for the step where the scripts should run. From 5f06ab2420250cc50bae53b4b8f50d15e6957cc4 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 12:05:53 +0000 Subject: [PATCH 04/15] Removing broken link --- .../guides/container-registries/docker-hub.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md index ba023f4d4b..cb820f2b28 100644 --- a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md +++ b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md @@ -33,7 +33,7 @@ To use the Docker Hub registry in Octopus Deploy, create an external feed with t - **Feed Type:** Docker Container Registry - **Name:** DockerHub (or anything else that makes sense to you) -- **URL:** [https://index.docker.io](https://index.docker.io) +- **URL:** https://index.docker.io - **Registry Path:** *leave blank* - **Credentials:** Username and Password (Login for your DockerHub account, this is required for accessing public repositories) From 0568c40b710706fb201c178cf47beb053b970a56 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 12:07:00 +0000 Subject: [PATCH 05/15] Fixing broken link --- src/pages/docs/releases/issue-tracking/jira.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/releases/issue-tracking/jira.md b/src/pages/docs/releases/issue-tracking/jira.md index efb6d5ece6..10c59d245f 100644 --- a/src/pages/docs/releases/issue-tracking/jira.md +++ b/src/pages/docs/releases/issue-tracking/jira.md @@ -111,7 +111,7 @@ This process is for Jira Cloud, if you are using Jira Server, see [Connecting Ji 4. Ensure the Octopus Server URL is set. - If you are using Octopus Cloud, this value is automatically set for you. If you are not using Octopus Cloud, navigate to the **Configuration ➜ Nodes** page and ensure you have set the Server URI field to your Octopus Server's base URL. i.e., https://my-company.octopus.app or https://my-company-internal-name + If you are using Octopus Cloud, this value is automatically set for you. If you are not using Octopus Cloud, navigate to the **Configuration ➜ Nodes** page and ensure you have set the Server URI field to your Octopus Server's base URL. i.e., https://my-company.octopus.app or https://my-company-internal-name Note: Octopus passes this value to Jira so it can build hyperlinks back to the deployments from the Jira UI. It never actually tries to connect to this URL itself. 5. Configure the Octopus plugin in Jira. From e9ad63ef43da68417ab1825540193ac47940c7fc Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 12:08:10 +0000 Subject: [PATCH 06/15] Update substitute-variables-in-templates.md --- .../substitute-variables-in-templates.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md index 9b1e1fe9e7..fbe49bcd46 100644 --- a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md +++ b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md @@ -26,8 +26,8 @@ The following example shows you how to use the Substitute Variables in Templates | Variable Name | Value | Scope | | ----------------------- | --------------- | -------- | -| LoginURL | https://test.example.com/login | Test | -| LoginURL | https://example.com/login | Production | +| LoginURL | https://test.example.com/login | Test | +| LoginURL | https://example.com/login | Production | 2. Include the loginURL variable in the app you're deploying, by adding the variable `#{LoginURL}`. For instance: From 217c237e4e5dee01c46a27c9123632b443c24dce Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:36:39 +0000 Subject: [PATCH 07/15] Fixing broken link --- .../guides/container-registries/docker-hub.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md index cb820f2b28..661d547595 100644 --- a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md +++ b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md @@ -16,7 +16,7 @@ From September 5th 2022, the Docker Hub Registry is [deprecating v1 endpoints](h **DockerHub Private Repository Limitations** By design, Docker Hub **does not support** [searching for private repositories](https://docs.docker.com/docker-hub/#/explore-repositories), even with valid credentials. Additionally, while you will be able to search for a non-official repository, Docker Hub *will not return any tags for unofficial images*. If you are using an unofficial image, you will be able to select this when configuring your run step, but you will need to manually enter the version that you wish to deploy. So long as it exists in the registry, your Docker Engine will be able to pull it down. -The Docker Hub API endpoint [https://index.docker.io/v1](https://index.docker.io/v1) provides access to repositories with different levels of access +The Docker Hub API endpoint `https://index.docker.io/v1` provides access to repositories with different levels of access | Repository | Shows In Search | Lists Tags | | --- | --- | --- | From 42a18ebb6c2893bc3248268a36fdf0bb83d1f3d6 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:37:45 +0000 Subject: [PATCH 08/15] Fixing broken links --- .../substitute-variables-in-templates.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md index fbe49bcd46..814824550c 100644 --- a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md +++ b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md @@ -26,8 +26,8 @@ The following example shows you how to use the Substitute Variables in Templates | Variable Name | Value | Scope | | ----------------------- | --------------- | -------- | -| LoginURL | https://test.example.com/login | Test | -| LoginURL | https://example.com/login | Production | +| LoginURL | `https://test.example.com/login` | Test | +| LoginURL | `https://example.com/login` | Production | 2. Include the loginURL variable in the app you're deploying, by adding the variable `#{LoginURL}`. For instance: From 30696f29fd219e4b907d0425433f4946a88a49ba Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:38:43 +0000 Subject: [PATCH 09/15] Fixing broken links --- src/pages/docs/releases/issue-tracking/jira.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/releases/issue-tracking/jira.md b/src/pages/docs/releases/issue-tracking/jira.md index 10c59d245f..2aac4fb761 100644 --- a/src/pages/docs/releases/issue-tracking/jira.md +++ b/src/pages/docs/releases/issue-tracking/jira.md @@ -111,7 +111,7 @@ This process is for Jira Cloud, if you are using Jira Server, see [Connecting Ji 4. Ensure the Octopus Server URL is set. - If you are using Octopus Cloud, this value is automatically set for you. If you are not using Octopus Cloud, navigate to the **Configuration ➜ Nodes** page and ensure you have set the Server URI field to your Octopus Server's base URL. i.e., https://my-company.octopus.app or https://my-company-internal-name + If you are using Octopus Cloud, this value is automatically set for you. If you are not using Octopus Cloud, navigate to the **Configuration ➜ Nodes** page and ensure you have set the Server URI field to your Octopus Server's base URL. i.e., `https://my-company.octopus.app` or `https://my-company-internal-name` Note: Octopus passes this value to Jira so it can build hyperlinks back to the deployments from the Jira UI. It never actually tries to connect to this URL itself. 5. Configure the Octopus plugin in Jira. From 7f17659dde94f8c573f14f5f29627b18daa209b2 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:39:33 +0000 Subject: [PATCH 10/15] Fixing broken links --- src/pages/docs/releases/issue-tracking/jira.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/releases/issue-tracking/jira.md b/src/pages/docs/releases/issue-tracking/jira.md index 2aac4fb761..74ebd97813 100644 --- a/src/pages/docs/releases/issue-tracking/jira.md +++ b/src/pages/docs/releases/issue-tracking/jira.md @@ -91,7 +91,7 @@ This process is for Jira Cloud, if you are using Jira Server, see [Connecting Ji In the Octopus Web Portal, navigate to **Configuration ➜ Settings ➜ Jira Integration** and copy the following values from the Jira App configuration page: - - **Jira Base URL**. This tells Octopus where your Jira instance is located and enables Octopus to render the links back to Jira issues. i.e., https://your-jira-instance.atlassian.net. + - **Jira Base URL**. This tells Octopus where your Jira instance is located and enables Octopus to render the links back to Jira issues. i.e., `https://your-jira-instance.atlassian.net`. - **Jira Connect App Password**. Ensure the **Is Enabled** property is set. From 8638e528bfe300c49d637ec2636b8c3ba21409ed Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:41:59 +0000 Subject: [PATCH 11/15] Removing broken link --- .../package-repositories/docker-registries/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md b/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md index 6be40f029c..54674077f2 100644 --- a/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md +++ b/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md @@ -54,7 +54,7 @@ When you create a release in Octopus, you need to choose the "version" of the Im :::div{.hint} **Container images are downloaded directly by the Deployment Target or Worker** -Octopus Deploy does not currently support functionality to push Images from the Octopus Server to the deployment targets in the same way that it does with other [supported packages](/docs/packaging-applications/#supported-formats). That being said, the [layered architecture of Images](https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers) allows your deployment targets to retrieve only those pieces that have changed from previous versions that are locally available, which is behavior built in to the Docker Engine. +Octopus Deploy does not currently support functionality to push Images from the Octopus Server to the deployment targets in the same way that it does with other [supported packages](/docs/packaging-applications/#supported-formats). That being said, the layered architecture of images allows your deployment targets to retrieve only those pieces that have changed from previous versions that are locally available, which is behavior built in to the Docker Engine. ::: ## Private registry {#private-registry} From 580a56b19ed7edf911abbb5526b3a1fef999eeb9 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:43:36 +0000 Subject: [PATCH 12/15] Fixing broken link --- src/pages/docs/security/users-and-teams/user-roles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/security/users-and-teams/user-roles.md b/src/pages/docs/security/users-and-teams/user-roles.md index 9bbbc4a62c..4b1e531724 100644 --- a/src/pages/docs/security/users-and-teams/user-roles.md +++ b/src/pages/docs/security/users-and-teams/user-roles.md @@ -82,7 +82,7 @@ The results will show: - The teams of which the user is a member of. There are two separate Permission context that you can check. - **Show System permissions** will show [System level permissions](/docs/security/users-and-teams/system-and-space-permissions) - **Show permissions within a specific space** will show [Space specific Permissions](/docs/security/users-and-teams/system-and-space-permissions). -- A chart detailing each role and on which Environment/Project this permission can be executed. The chart can be exported to a CSV file by clicking the Export button. Once the file is downloaded it can viewed in browser using [Online CSV Editor and Viewer](http://www.convertcsv.com/csv-viewer-editor.htm). +- A chart detailing each role and on which Environment/Project this permission can be executed. The chart can be exported to a CSV file by clicking the Export button. Once the file is downloaded it can viewed in browser using [Online CSV Editor and Viewer](https://www.convertcsv.com/csv-viewer-editor.htm). :::figure ![](/docs/security/users-and-teams/images/systempermissions.png) From a7ce3cd408667c9d03d29f96fcd64c00216ab8e2 Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:45:50 +0000 Subject: [PATCH 13/15] Fixing broken links From 61bac87603d1c84c4060c6d759c40648f207d30b Mon Sep 17 00:00:00 2001 From: tonykelly-octopus <109653283+tonykelly-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:49:27 +0000 Subject: [PATCH 14/15] Anchor link fix --- .../configuration-features/substitute-variables-in-templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md index 814824550c..4f4cdc8103 100644 --- a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md +++ b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md @@ -77,7 +77,7 @@ If you include a configuration file that you are also doing a [transformation](/ By default **warnings** will be treated as **errors** when replacing variables in files using this feature. To override this behavior, set the variable **Octopus.Action.Package.IgnoreVariableReplacementErrors** to **True** in your project. By doing this, warnings will be treated as such and the deployment will not be marked as failed. ::: -## Examples {#SubstituteVariablesinFiles-SomeExamples} +## Examples {#SubstituteVariablesInFiles-SomeExamples} ### Swapping design elements From a4228127eb53950ba13dea095f0055eb224f2337 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Thu, 21 Nov 2024 15:52:05 +0000 Subject: [PATCH 15/15] Update src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md --- .../guides/container-registries/docker-hub.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md index 661d547595..4cca548254 100644 --- a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md +++ b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md @@ -33,7 +33,7 @@ To use the Docker Hub registry in Octopus Deploy, create an external feed with t - **Feed Type:** Docker Container Registry - **Name:** DockerHub (or anything else that makes sense to you) -- **URL:** https://index.docker.io +- **URL:** `https://index.docker.io` - **Registry Path:** *leave blank* - **Credentials:** Username and Password (Login for your DockerHub account, this is required for accessing public repositories)