-
Notifications
You must be signed in to change notification settings - Fork 250
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/Standardize alias
#3011
Conversation
@@ -102,8 +102,9 @@ Optional attributes: | |||
<tr> | |||
<td><code>key</code></td> | |||
<td> | |||
<p>A unique string to identify the block step.</p> | |||
<p>A unique string to identify the block step.<br>Keys can not have the same pattern as a UUID (<code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code>).</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure why bloack_step.md
uses <p>
for all the table cells, but none of the others do 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question @thejcannon , and thanks for pointing this out. I'm not sure why this is the case either.
I'll remove these <p></p>
elements from this table then; this also appears to affect about 1/2 the HTML tables on this page.
@@ -118,9 +119,9 @@ Optional attributes: | |||
<tr> | |||
<td><code>key</code></td> | |||
<td> | |||
A unique string to identify the step. The value is available in the <code>BUILDKITE_STEP_KEY</code> <a href="/docs/pipelines/environment-variables">environment variable</a>.<br> | |||
A unique string to identify the command step. The value is available in the <code>BUILDKITE_STEP_KEY</code> <a href="/docs/pipelines/environment-variables">environment variable</a>.<br> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Thanks very much for this PR update @thejcannon ! 🎉 These consistency updates are much appreciated! As mentioned above, I've removed the unnecessary
I gather you meant Wait (instead of Input) here. Anyway, while I'm pretty sure these are correct, I'll ask a colleague to provide a 2nd opinion first, and then'll merge these in! Thanks again |
Hmm I'm not seeing where you did this. Did you mean to do it on my branch? Or did you do this on
Yup! Updated! |
Thanks for your replies!
They've been done (along with the removal of the unnecessary |
FYI @thejcannon , please don't worry about the merge conflicts in this working branch of yours. We've just implemented some major restructuring of most of the Pipeline docs pages to make them follow a consistent URL pattern. These changes are now in the EDIT: I just wrote this comment in the event that you received a notification about merge conflicts. Having said that, this was only a fleeting state and this PR was merged without issue (along with the additional commits from the mirrored branch). |
key
has aliasesidentifier
andid
(however I suspect y'all don't want to advertise the latter due to confusion withBUILDKITE_STEP_ID
(not being theid
)) so make sureidentifier
is listed as an aliaskey
skey
field to Trigger and Wait step docs