Skip to content

Update Script Console docs for its move to space-level Tasks - #3536

Open
iryan2 wants to merge 1 commit into
mainfrom
ianryan/sf-3967-update-docs-for-script-console
Open

iryan2 wants to merge 1 commit into
mainfrom
ianryan/sf-3967-update-docs-for-script-console

Conversation

@iryan2

@iryan2 iryan2 commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Background

[SF-3967]

The Script console button has been moved from the global Tasks page to the space-level Tasks page (Deploy ➜ Tasks) in Octopus Server 2027.0, because the Script Console runs scripts within a space. The Script Console docs still described it as being "under the Tasks area" and showed a screenshot of the old location.

Results

The Script Console page now explains that the button is only on a space's Tasks page, not the global one, and tells readers how to get there. The screenshot has been replaced with one of the space-level Tasks page, and a version note records the move for readers on versions before 2027.0. Separately, the "script console" link on the custom step templates page, which pointed at the web request logging page, now points at the Script Console page.

Before

Script Console page, Use the Script Console section — before

After

Script Console page, Use the Script Console section — after Script Console page, new Version notes section

How to review this PR

Reducing risk

Automated Tests

  • Run full chain build (PRs targeting main and release/* branches only)
  • Run branch chain build (only required if you need a backend build to run for a front-end change. PRs targeting main and release/* branches only)
  • Spin up Armada test instance for this change

Pre-requisites

  • I have read How we use GitHub Issues for help deciding when and where it's appropriate to make an issue.
  • I have considered informing or consulting the right people, according to the ownership map.
  • I have considered the appropriate target version for this PR.
  • I have considered appropriate testing for my change.
    • Automated testing / Exploratory testing / Nothing required?
  • I have considered manually testing my changes on a branch instance to check correctness, stability and performance on Octopus Cloud.
  • I have considered safety nets to reduce any time-to-recovery for my change.

The Script Console runs within a space, so the button now lives on
Deploy > Tasks rather than the global Tasks page. Also fix the custom
step templates page linking "script console" to the web request
logging page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@team-marketing-branch-protections

Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3536.z22.web.core.windows.net/.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

## Running script based custom step templates

You can run script based custom step templates on a group of machines. This can be very handy to execute script based step templates to test them before starting to use them in your projects as well as performing regular admin or operations functions. This should be familiar to people who have used the [script console](/docs/administration/managing-infrastructure/performance/enable-web-request-logging) in the past.
You can run script based custom step templates on a group of machines. This can be very handy to execute script based step templates to test them before starting to use them in your projects as well as performing regular admin or operations functions. This should be familiar to people who have used the [script console](/docs/administration/managing-infrastructure/script-console) in the past.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive-by fix for link url

@iryan2
iryan2 marked this pull request as ready for review October 27, 2026 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants