docs icon indicating copy to clipboard operation
docs copied to clipboard

Added external feed trigger docs

Open MissedTheMark opened this issue 5 months ago • 4 comments

To save you running the project locally, this is a rendered version of the new triggers page as at commit d13b9c2: image image image image image image

Changes to the Releases and Dependencies page

Before

image

After

image

Changes to the ARC page

Added this heading to the ARC page (now Built-in package repository triggers): image

There are a few other changes included in the move from ARC to built in package repo triggers.

[sc-61201] [sc-73064]

MissedTheMark avatar Mar 22 '24 04:03 MissedTheMark

@MissedTheMark I have a PR to resolve your spelling woes here:

https://github.com/OctopusDeploy/docs/pull/2237

steve-fenton-octopus avatar Apr 16 '24 10:04 steve-fenton-octopus

Should we highlight in the doc intro that this feature is for Kubernetes? Maybe the first sentence could say something like, 'This feature enables pull-driven deployments for Kubernetes steps'.

Should we have a history section in the doc?

Should we explain how the feature works? Something like it creates a task every 3 minutes, etc.

I believe the channel and source sections miss whys. I.e. what are the use cases for this? We can explain that you might want to test an interim version and don't want to promote it to production, in this case you can use this tag, or if it's a hothix, use this. The same is true for the source selection; we could say something like, 'If you have a 3rd party repo, you can monitor all the included packages to spot updates automatically).

The paragraph above makes me think that we'll benefit from a new doc, something like 'triggers best practices' or 'triggers use cases'. We could show a few examples like

  • 3rd party Helm chart where customers don't even use variables in the chart but just specify containers to monitor
  • Microservices (multiple containers), where we monitor just the last container to avoid premature releases
  • Security updates where we immediately push to production all the containers with security tags (maybe, it's a silly example).

nikita-dergilev avatar Apr 17 '24 00:04 nikita-dergilev

@nikita-dergilev

Should we highlight in the doc intro that this feature is for Kubernetes? Maybe the first sentence could say something like, 'This feature enables pull-driven deployments for Kubernetes steps'.

Should we have a history section in the doc?

Should we explain how the feature works? Something like it creates a task every 3 minutes, etc.

These are good points, I'll make some updates

The second half of the message I've referenced in this card.

Unsure if we'll do it as a separate PR or bring it in here too. I think the plan will be to merge these docs as we roll out to prod.

eddymoulton avatar Apr 17 '24 03:04 eddymoulton