From 800d27edfa3c4caa100c198e5178aa5e62a54985 Mon Sep 17 00:00:00 2001 From: harrisonmeister Date: Thu, 11 Dec 2025 17:31:23 +0000 Subject: [PATCH 1/3] Remove feature toggle for tagset wording --- .../docs/infrastructure/environments/index.mdx | 2 +- .../examples/tagsets/create-tagset.mdx | 2 +- src/pages/docs/projects/setting-up-projects.md | 16 ++++++++-------- src/pages/docs/tenants/tag-sets.md | 2 -- src/pages/docs/tenants/tenant-tags.md | 2 +- 5 files changed, 11 insertions(+), 13 deletions(-) diff --git a/src/pages/docs/infrastructure/environments/index.mdx b/src/pages/docs/infrastructure/environments/index.mdx index 5c66f1ee0a..8b2c6caec7 100644 --- a/src/pages/docs/infrastructure/environments/index.mdx +++ b/src/pages/docs/infrastructure/environments/index.mdx @@ -35,7 +35,7 @@ To edit individual environments, click the overflow menu (...) for that environm ## Environment tags :::div{.warning} -From Octopus Cloud version **2025.4.3897** we support tagging environments. This functionality is behind the `Extended Tag Sets` feature toggle, to request this functionality early, please contact [support](https://octopus.com/support). +From Octopus Cloud version **2025.4.3897** we support tagging environments. ::: You can create and assign tags to environments. This allows you to: diff --git a/src/pages/docs/octopus-rest-api/examples/tagsets/create-tagset.mdx b/src/pages/docs/octopus-rest-api/examples/tagsets/create-tagset.mdx index 8a5ce9f46d..ca7ae18585 100644 --- a/src/pages/docs/octopus-rest-api/examples/tagsets/create-tagset.mdx +++ b/src/pages/docs/octopus-rest-api/examples/tagsets/create-tagset.mdx @@ -10,7 +10,7 @@ import CreateTagsetScripts from 'src/shared-content/scripts/create-tagset-script This script demonstrates how to programmatically create a tag set in Octopus Deploy. :::div{.hint} -From Octopus Cloud version **2025.4.3897**, `Type` and `Scopes` parameters can be included to configure the type of and scoping of a tag set when created via the API. This functionality is behind the `Extended Tag Sets` feature toggle, to request this functionality early, please contact [support](https://octopus.com/support). +From Octopus Cloud version **2025.4.3897**, `Type` and `Scopes` parameters can be included to configure the type of and scoping of a tag set when created via the API. The API will ignore the `Type` and `Scopes` parameters if the `Extended Tag Sets` feature toggle is disabled. ::: diff --git a/src/pages/docs/projects/setting-up-projects.md b/src/pages/docs/projects/setting-up-projects.md index c3bf3874a4..3a37f3d318 100644 --- a/src/pages/docs/projects/setting-up-projects.md +++ b/src/pages/docs/projects/setting-up-projects.md @@ -13,7 +13,7 @@ You can manage your projects by navigating to the **Projects** tab in the Octopu ![Octopus Dashboard](/docs/img/projects/octopus-projects-list.png) ::: -If you have already created projects, or are joining an existing team, you’ll see the existing projects on the projects page. +If you have already created projects, or are joining an existing team, you'll see the existing projects on the projects page. ## Add a project @@ -25,14 +25,14 @@ Before you can define your deployment processes or runbooks, you must create a p 4. Add a description for the project. 5. If you want to change the [Project group](#project-group) select an existing project group from the drop-down menu. 6. If you want to change the [Lifecycle](/docs/releases/lifecycles) select an existing lifecycle from the drop down menu. -7. Click **SHOW LIFECYCLE** if you’d like to see a visual representation of the selected lifecycle. -8. Click **SAVE** and you will be taken to the newly created project’s overview page. +7. Click **SHOW LIFECYCLE** if you'd like to see a visual representation of the selected lifecycle. +8. Click **SAVE** and you will be taken to the newly created project's overview page. -Now that you’ve created a project, you can define your [deployment process](/docs/projects/deployment-process/) or [runbooks](/docs/runbooks). +Now that you've created a project, you can define your [deployment process](/docs/projects/deployment-process/) or [runbooks](/docs/runbooks). ## Project settings -You can change the projects settings by accessing the settings menu on the project’s main page. The settings you can change are: +You can change the projects settings by accessing the settings menu on the project's main page. The settings you can change are: - Name - Enable or disable the project to allow or prevent releases and deployments from being created @@ -45,7 +45,7 @@ You can change the projects settings by accessing the settings menu on the proje ## Project tags {#project-tags} :::div{.warning} -From Octopus Cloud version **2025.4.3897** we support tagging projects. This functionality is behind the `Extended Tag Sets` feature toggle, to request this functionality early, please contact [support](https://octopus.com/support). +From Octopus Cloud version **2025.4.3897** we support tagging projects. ::: You can apply tags to projects to classify and organize them with custom metadata. This allows you to: @@ -70,14 +70,14 @@ Learn more about [tag sets](/docs/tenants/tag-sets), including tag set types, sc - Deployment target status - Choose to skip unavailable, or exclude unhealthy targets from the deployment. - [Deployment changes template](/docs/releases/deployment-changes#templates) - - Specify a template for each deployment’s changes. + - Specify a template for each deployment's changes. - Default failure mode - Specify whether or not to use [guided failure mode](/docs/releases/guided-failures). ## Project logo \{#project-logo} Customize your project logo to make it easily identifiable amongst other projects. -1. From the project’s main page, select **Settings**. +1. From the project's main page, select **Settings**. 2. Click the **Logo** section of the settings page. 3. Select from our built-in icon library paired with your choice of color or upload a custom image. 4. Click **Save**. diff --git a/src/pages/docs/tenants/tag-sets.md b/src/pages/docs/tenants/tag-sets.md index 805d62f250..4cb7c4cd72 100644 --- a/src/pages/docs/tenants/tag-sets.md +++ b/src/pages/docs/tenants/tag-sets.md @@ -15,8 +15,6 @@ Tag sets provide the structure for grouping similar tags together, resulting in :::div{.warning} From Octopus Cloud version **2025.4.3897** we have extended the functionality of tag sets to include the type and scope of a tag set. - -This functionality is behind the `Extended Tag Sets` feature toggle, to request this functionality early, please contact [support](https://octopus.com/support). ::: ## Tag set types {#tag-set-types} diff --git a/src/pages/docs/tenants/tenant-tags.md b/src/pages/docs/tenants/tenant-tags.md index c94885e0fd..bccd28a93b 100644 --- a/src/pages/docs/tenants/tenant-tags.md +++ b/src/pages/docs/tenants/tenant-tags.md @@ -11,7 +11,7 @@ navOrder: 40 :::div{.hint} This page covers how to use tags with tenants. For general information about tag sets, types, and scopes, see [Tag sets](/docs/tenants/tag-sets). -From Octopus Cloud version **2025.4.3897** we've introduced **SingleSelect** and **FreeText** tag set types. This functionality is behind the `Extended Tag Sets` feature toggle, to request this functionality early, please contact [support](https://octopus.com/support). +From Octopus Cloud version **2025.4.3897** we've introduced **SingleSelect** and **FreeText** tag set types. ::: Tenant tags allow you to: From ae78c4cdce216baa3ed67605a8cd5908e509e5b5 Mon Sep 17 00:00:00 2001 From: harrisonmeister Date: Thu, 11 Dec 2025 17:45:12 +0000 Subject: [PATCH 2/3] Linting fixes for markdown --- .../infrastructure/environments/index.mdx | 2 +- .../docs/projects/setting-up-projects.md | 29 ++++++++++--------- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/src/pages/docs/infrastructure/environments/index.mdx b/src/pages/docs/infrastructure/environments/index.mdx index 8b2c6caec7..92ef6ee16b 100644 --- a/src/pages/docs/infrastructure/environments/index.mdx +++ b/src/pages/docs/infrastructure/environments/index.mdx @@ -30,7 +30,7 @@ Take a look at our [environment recommendations](/docs/infrastructure/environmen ## Edit your environments -To edit individual environments, click the overflow menu (...) for that environment. From here, it is possible to edit the environment, description, change the [guided failure mode](#guided-failure-mode), enable or disable [dynamic infrastructure](/docs/infrastructure/deployment-targets/dynamic-infrastructure), or delete the environment. +To edit individual environments, click the overflow menu (...) for that environment. From here, it is possible to edit the environment, description, change the [guided failure mode](/docs/releases/guided-failures#enable-guided-failure-mode-for-an-environment), enable or disable [dynamic infrastructure](/docs/infrastructure/deployment-targets/dynamic-infrastructure), or delete the environment. ## Environment tags diff --git a/src/pages/docs/projects/setting-up-projects.md b/src/pages/docs/projects/setting-up-projects.md index 3a37f3d318..600c5c69a7 100644 --- a/src/pages/docs/projects/setting-up-projects.md +++ b/src/pages/docs/projects/setting-up-projects.md @@ -61,20 +61,22 @@ Only tags from tag sets that have been configured with the **Project** scope can Learn more about [tag sets](/docs/tenants/tag-sets), including tag set types, scopes, and how to create and manage them. ## Deployment settings + - Package re-deployment - - Specify to always deploy all packages or to skip any package steps that are already installed. + - Specify to always deploy all packages or to skip any package steps that are already installed. - Deployment targets - - Specify if deployments are allowed if there are no deployment targets: - - Deployments with no target are allowed - There must be at least one enabled healthy target to deploy to in the environment. - - Allow deployments to be created when there are no deployment targets - Use this where no steps in the process have targets (or are all run on the Server), or you are dynamically adding targets during deployment. + - Specify if deployments are allowed if there are no deployment targets: + - Deployments with no target are allowed - There must be at least one enabled healthy target to deploy to in the environment. + - Allow deployments to be created when there are no deployment targets - Use this where no steps in the process have targets (or are all run on the Server), or you are dynamically adding targets during deployment. - Deployment target status - - Choose to skip unavailable, or exclude unhealthy targets from the deployment. + - Choose to skip unavailable, or exclude unhealthy targets from the deployment. - [Deployment changes template](/docs/releases/deployment-changes#templates) - - Specify a template for each deployment's changes. + - Specify a template for each deployment's changes. - Default failure mode - - Specify whether or not to use [guided failure mode](/docs/releases/guided-failures). + - Specify whether or not to use [guided failure mode](/docs/releases/guided-failures). ## Project logo \{#project-logo} + Customize your project logo to make it easily identifiable amongst other projects. 1. From the project's main page, select **Settings**. @@ -93,6 +95,7 @@ Project groups are a great way to organize your deployment projects. They have m :::div{.hint} The *Default Project* group contains all projects that have not been added to another group. ::: + ## Add a project group 1. From the **Projects** tab, click **ADD GROUP**. @@ -124,13 +127,13 @@ Projects can be cloned. 1. From the project's menu, select **Settings**. 2. Click the overflow menu (...), and select **Clone**. -:::figure -![Clone a project](/docs/img/projects/images/clone-project.png) -::: + :::figure + ![Clone a project](/docs/img/projects/images/clone-project.png) + ::: -:::div{.warning} -**Version-controlled projects are not currently supported** -::: + :::div{.warning} + **Version-controlled projects are not currently supported** + ::: 3. Give the new project you are cloning from the original project a name. 4. Review the settings for the new project and when you are satisfied, click **SAVE**. From e8801aed52135b223a3aa4784f4e11c714401c89 Mon Sep 17 00:00:00 2001 From: harrisonmeister Date: Thu, 11 Dec 2025 17:57:13 +0000 Subject: [PATCH 3/3] More linting fixes for markdown --- .../docs/infrastructure/environments/index.mdx | 2 +- src/pages/docs/projects/setting-up-projects.md | 2 +- src/pages/docs/tenants/tag-sets.md | 11 ++++++----- src/pages/docs/tenants/tenant-tags.md | 13 +++++++------ 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/src/pages/docs/infrastructure/environments/index.mdx b/src/pages/docs/infrastructure/environments/index.mdx index 92ef6ee16b..8cb62d6958 100644 --- a/src/pages/docs/infrastructure/environments/index.mdx +++ b/src/pages/docs/infrastructure/environments/index.mdx @@ -85,7 +85,7 @@ This will let you search by: ## Removing environments -For projects using Config as Code, it's up to you to take care to avoid deleting any environments required by your deployments or runbooks. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information. +For projects using Config as Code, it's up to you to take care to avoid deleting any environments required by your deployments or runbooks. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information. ## Learn more diff --git a/src/pages/docs/projects/setting-up-projects.md b/src/pages/docs/projects/setting-up-projects.md index 600c5c69a7..34b615a16f 100644 --- a/src/pages/docs/projects/setting-up-projects.md +++ b/src/pages/docs/projects/setting-up-projects.md @@ -138,4 +138,4 @@ Projects can be cloned. 3. Give the new project you are cloning from the original project a name. 4. Review the settings for the new project and when you are satisfied, click **SAVE**. -After you've cloned a project, you can see details about where your project was cloned from and which projects have been cloned from your project, by navigating to the project's overview page and selecting **Settings** and looking at the **Cloning History** section. \ No newline at end of file +After you've cloned a project, you can see details about where your project was cloned from and which projects have been cloned from your project, by navigating to the project's overview page and selecting **Settings** and looking at the **Cloning History** section. diff --git a/src/pages/docs/tenants/tag-sets.md b/src/pages/docs/tenants/tag-sets.md index 4cb7c4cd72..747f2b1662 100644 --- a/src/pages/docs/tenants/tag-sets.md +++ b/src/pages/docs/tenants/tag-sets.md @@ -10,7 +10,7 @@ navOrder: 35 Tag sets provide the structure for grouping similar tags together, resulting in more orderly metadata. Currently, tags can be applied to tenants and environments, with support for additional resource types planned for the future. :::figure -![](/docs/img/tenants/images/tag-sets.png) +![An example set of tenant tags](/docs/img/tenants/images/tag-sets.png) ::: :::div{.warning} @@ -29,8 +29,8 @@ There are three types of tag sets that can be created: Tag sets can be scoped to specific resource types: -- **Tenant** -- **Environment** +- **Tenant** +- **Environment** - **Project** A tag set can be scoped to multiple resource types (Tenant, Environment, and/or Project), allowing you to use the same tag set across different resources. @@ -40,7 +40,7 @@ A tag set can be scoped to multiple resource types (Tenant, Environment, and/or Go to **Deploy ➜ Tag Sets** to create, modify and reorder tag sets and tags. :::figure -![](/docs/img/tenants/images/tenant-importance.png) +![The tenant tag set edit screen](/docs/img/tenants/images/tenant-importance.png) ::: ### Design your tag sets carefully {#design-tag-sets-carefully} @@ -60,7 +60,7 @@ Grouping tag sets makes it easier for each different class of Octopus user to un Order is important for tag sets, and tags within those tag sets. Octopus will sort tag sets and tags based on the order you define in the library. This allows you to tailor the Octopus user interface to your own situation. :::figure -![](/docs/img/tenants/images/tag-set-order.png) +![Ordering of tenant tags shown in the deployment target restrictions section](/docs/img/tenants/images/tag-set-order.png) ::: ### Removing tags @@ -74,6 +74,7 @@ For projects using Config as Code, there are fewer guardrails in place. It's up Tags are referenced using their **canonical name** which looks like this: `Tag Set Name/Tag Name` For example: + - `Release Ring/Alpha` - References the predefined "Alpha" tag in the "Release Ring" tag set - `Importance/VIP` - References the predefined "VIP" tag in the "Importance" tag set - `Region/us-west-2` - For FreeText tag sets, the tag set name "Region" must match exactly, but "us-west-2" can be any arbitrary value diff --git a/src/pages/docs/tenants/tenant-tags.md b/src/pages/docs/tenants/tenant-tags.md index bccd28a93b..0ff0e40259 100644 --- a/src/pages/docs/tenants/tenant-tags.md +++ b/src/pages/docs/tenants/tenant-tags.md @@ -23,7 +23,7 @@ Tenant tags allow you to: - Scope project variables to tenant tags. - Design a multi-tenant hosting model - read more in our [tenant infrastructure](/docs/tenants/tenant-infrastructure) section. - Design a multi-tenant deployment process for SaaS applications, regions and more - for further details, see our [guides](/docs/tenants/guides/#guides). -- Control which releases can be deployed to tenants using [channels](/docs/releases/channels/) - read more in our [tenant lifecycle](/docs/tenants/tenant-lifecycles) section. +- Control which releases can be deployed to tenants using [channels](/docs/releases/channels/) - read more in our [tenant lifecycle](/docs/tenants/tenant-lifecycles) section. ## Tag-based filters {#tag-based-filters} @@ -38,7 +38,7 @@ When filtering tenants, Octopus will combine tags within the same tag set using Let's take a look at an example: :::figure -![](/docs/img/tenants/images/tag-based-filters.png) +![A dialog showing a Tenant preview when selecting different tenant tags](/docs/img/tenants/images/tag-based-filters.png) ::: In this example Octopus will execute a query like the one shown below: @@ -55,6 +55,7 @@ When paired with a well-structured tag design, this logic will enable you to tai - Only specify a tenant "by name" (explicitly) if you absolutely want that tenant included in the result, otherwise leave it blank - A filter with tags in the same tag set will be more inclusive since they are combined using **`OR`** - A filter with tags across different tag sets will become more reductive since they are combined using **`AND`** + ::: ## Referencing tenant tags {#referencing-tenant-tags} @@ -64,7 +65,7 @@ If you want to use tenant tags to automate Octopus Deploy you should use the **c Consider an example deploying a release to the tenants tagged with the **Alpha** tag in the **Release Ring** tag set. :::figure -![](/docs/img/tenants/images/release-ring.png) +![A tenant tag of Alpha from the Release Ring tag set is shown highlighting how you should reference it in automation scenarios](/docs/img/tenants/images/release-ring.png) ::: ```powershell @@ -95,7 +96,7 @@ First, create a tag set called **Upgrade Ring** with tags that allow each tenant Learn more about [creating and managing tag sets](/docs/tenants/tag-sets#managing-tag-sets). :::figure -![](/docs/img/tenants/images/multi-tenant-upgrade-ring.png) +![A dialog showing the creation of a tenant tag set called Upgrade Ring](/docs/img/tenants/images/multi-tenant-upgrade-ring.png) ::: ### Step 2: Configure a test tenant {#deploy-step-2-configure-test-tenant} @@ -111,13 +112,13 @@ Either create a new tenant or configure an existing tenant. Tag your test tenant Now it's time to deploy using tenant tags as a way to select multiple tenants easily. In this example, we will deploy version **1.0.1** to all tenants tagged with **Tester** who are connected to the **Test** environment. You can use multiple tags and complex tag queries to achieve other interesting scenarios. :::figure -![](/docs/img/tenants/images/multi-tenant-deploy-test.png) +![A screenshot showing the deployment preview when selecting tenants tagged with Tester](/docs/img/tenants/images/multi-tenant-deploy-test.png) ::: You can also use the project overview to deploy to groups of tenants by grouping the dashboard, selecting a release, and clicking the **Deploy all...** button. :::figure -![](/docs/img/tenants/images/multi-tenant-deploy-all.png) +![A screenshot showing how you can use the project dashboard to select tenants to deploy using a tenant tag](/docs/img/tenants/images/multi-tenant-deploy-all.png) ::: ## Learn more