Improve docs for custom fields on releases #2836
Conversation
geofflamrock
force-pushed
the
geoffl/custom-fields-on-releases
branch
2 times, most recently
from
48494db to
de1aefc
Compare
geofflamrock
changed the title
geofflamrock
force-pushed
the
geoffl/custom-fields-on-releases
branch
from
de1aefc to
f1fdd73
Compare
| Channels allow you to define which custom fields are required when creating a release within the channel, ensuring you can use them within scripts and steps in the deployment process. | ||
|
|
||
| :::div{.hint} | ||
| Support for custom fields in releases is rolling out Octopus Cloud in Early Access Preview. |
There was a problem hiding this comment.
Should this say: "rolling out to Octopus Cloud"?
|
|
||
| :::div{.hint} | ||
| Support for custom fields on releases is rolling out Octopus Cloud in Early Access Preview as part of the Ephemeral Environments feature. | ||
| Support for custom fields on releases is rolling out Octopus Cloud in Early Access Preview. |
There was a problem hiding this comment.
As above, are we missing the word "to"?
| - The maximum length of the key and value of each custom field is 150 characters. | ||
| ### Required custom fields | ||
|
|
||
| Channels can define which custom fields are required when creating a release within the channel. The Octopus Web Portal will prompt to set any required custom fields when creating a release. Learn more about [configuring custom fields in channels](/docs/releases/channels). |
There was a problem hiding this comment.
The Octopus Web Portal will prompt to set any required custom fields when creating a release.
This sentence feels a little clunky. I'm not sure what would be better though.
Maybe: "The Octopus Web Portal will provide a prompt to set..."? 🤷
There was a problem hiding this comment.
Yeah it's a bit clunky, I've looked for other examples of "prompt" and most of them have "prompt you to..." so I might just go with that and we can adjust later.
|
|
||
| The following restrictions apply to custom fields on releases: | ||
|
|
||
| - A maximum of 10 custom fields can be added to each release. |
There was a problem hiding this comment.
More of a product question than a docs one, but does the same limit apply to required fields on a Channel? If so, maybe we should mention it in the Channels doco.
geofflamrock
force-pushed
the
geoffl/custom-fields-on-releases
branch
from
475e478 to
c00a09d
Compare
Improves docs for custom fields on releases now that more improvements to configure required custom fields via channels are rolling out to Octopus Cloud.
[sc-120205]