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

Added external feed trigger docs #2218

Merged
merged 16 commits into from
Apr 22, 2024
Merged

Added external feed trigger docs #2218

merged 16 commits into from
Apr 22, 2024

Conversation

MissedTheMark
Copy link
Contributor

@MissedTheMark MissedTheMark commented Mar 22, 2024

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]

Unlike the existing [Automatic Release Creation](/docs/projects/project-triggers/automatic-release-creation) feature, you can create multiple external feed triggers per channel. This can enable you to, for example, have your external container dependencies in a separate trigger to that used for your internal container dependencies.

:::figure
![Channel selection](/docs/projects/project-triggers/images/external-trigger-channel.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps changing to an image with an automatically deployed phase would be good here?

Copy link

@MissedTheMark MissedTheMark marked this pull request as ready for review April 12, 2024 02:40
@steve-fenton-octopus
Copy link
Contributor

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

#2237

@eddymoulton eddymoulton changed the title Added external feed trigger docs WIP Added external feed trigger docs Apr 17, 2024
@nikita-dergilev
Copy link
Contributor

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).

@eddymoulton
Copy link
Contributor

@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 eddymoulton merged commit bfab379 into main Apr 22, 2024
4 checks passed
@eddymoulton eddymoulton deleted the MissedTheMark/Enh/Triggers branch April 22, 2024 00:57
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.

5 participants