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

Update docs for 'Creating a pipeline template' #2285

Merged

Conversation

kalopilato
Copy link
Contributor

We recently modified the user flow for creating a Pipeline template so we need docs to reflect this change. We no longer immediately create a template, we now follow a more standard creation flow: click create > fill out a form > click save.

@github-actions github-actions bot added the pipelines Pull requests that update content related to Pipelines label Jul 5, 2023
@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2285--bk-docs-preview.netlify.app

1. Update the name and description of your new template and select _Apply_ to save your changes.
1. Select _Edit_ if you want to change the step configuration for the template.
1. If this is your first template, select _Create a Template_. Otherwise, select _New Template_.
1. Enter the name and description for your new template, update the default step configuration and select _Create Template_ to create the template.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's a good practice to do one instruction per step, which I think we can here:

Suggested change
1. Enter the name and description for your new template, update the default step configuration and select _Create Template_ to create the template.
1. Enter the name and description for your new template.
1. Update the default step configuration.
1. Select _Create Template_.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice one 👌 Should've just clicked commit but have applied in c82fd48

Copy link
Contributor

@mbelton-buildkite mbelton-buildkite left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@kalopilato kalopilato merged commit f81f345 into main Jul 6, 2023
1 check passed
@kalopilato kalopilato deleted the edge-1153-update-docs-to-match-new-template-creation-flow branch July 6, 2023 02:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pipelines Pull requests that update content related to Pipelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants