Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Workers docs for Octopus Cloud #2025

Merged
merged 14 commits into from
Dec 7, 2023

Conversation

samjetski
Copy link
Contributor

@samjetski samjetski commented Oct 4, 2023

[sc-62106]

Aside from the Dynamic Workers page, the current Workers section is exclusively oriented towards self-hosted Octopus.

We have some opportunities here:

  • Sell the Octopus Cloud offering, to support our Cloud Revenue OKR
    • The DW page doesn't currently link to Octopus Cloud anywhere
    • No other part of Workers mentions DW or cloud, despite it being a significant part of our offering
  • Fix the broader Workers and Worker Pools docs to include Dynamic Workers as an option
    • For a potential customer, it just looks way more complex than it needs to be
    • For a cloud customer getting started, it leads them away from the easy route. The "Built-In Worker" explanation is misleading, deploying your own tentacle worker is usually unnecessary, and they would have to stumble on Dynamic Workers by accident.
  • Clarify what the default pool does (there must always be one, but what is it?), and how it differs across self-hosted and cloud.
  • Improve our guidance about selecting worker image versions. We should recommend using worker-tools images as first preference over selecting a worker OS version.

Changes required before merging:

  • Merge Change Dynamic Worker defaults to Linux #2024
  • Reflect current default DW pool. Either:
    • Include cutover date in doc, i.e. "Cloud customers who signed up before... will have Windows as the default pool on new spaces, and on existing spaces unless they have changed it", or
    • Revert default pool info to Windows, and update later when publishing cut-over date
  • Update modified date on all pages

This was raised as part of Make Linux the default Dynamic Worker.

@shortcut-integration
Copy link

This pull request has been linked to Shortcut Story #59991: Update public documentation around Dynamic Worker Pools.

@CLAassistant
Copy link

CLAassistant commented Oct 4, 2023

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@samjetski samjetski self-assigned this Oct 5, 2023
@shortcut-integration
Copy link

This pull request has been linked to Shortcut Story #62106: Improve public documentation around Dynamic Workers.

@samjetski samjetski force-pushed the samj/workers-cloud-improvements branch from bc33b29 to 25b264d Compare November 17, 2023 01:01
@samjetski samjetski marked this pull request as ready for review November 17, 2023 01:09
@steve-fenton-octopus
Copy link
Contributor

Hi @samjetski

I've pushed a little fix for spelling related things, which involved a merge from main (to get the latest dictionary).

Copy link
Contributor

@steve-fenton-octopus steve-fenton-octopus left a comment

Choose a reason for hiding this comment

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

LGTM

@steve-fenton-octopus steve-fenton-octopus merged commit 4552538 into main Dec 7, 2023
4 checks passed
@steve-fenton-octopus steve-fenton-octopus deleted the samj/workers-cloud-improvements branch December 7, 2023 12:05
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