Add doc for environment state - #3319
Conversation
yangguoif
changed the title
|
Pull request environment is available at https://stoctodocspr3319.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
75be84c to
746257b
Compare
geofflamrock
left a comment
geofflamrock
left a comment
There was a problem hiding this comment.
This looks pretty good, I've left a few small suggestions and questions, happy to pair on working through anything here.
Co-authored-by: Geoff Lamrock <geoff.lamrock@gmail.com>
Co-authored-by: Geoff Lamrock <geoff.lamrock@gmail.com>
geofflamrock
left a comment
geofflamrock
left a comment
There was a problem hiding this comment.
Looks good and is pretty much ready to go I think. I've left a few final thoughts after a second read-through and we may end up wanting to adjust some of that screenshot but this prob doesn't need another look at we can just do those and merge when ready.
| | `Octopus.Environment.MachinesInRole[role]` | The machines with the specified target tag being deployed to. | `machines-123,machines-124` | | ||
| | `Octopus.Environment.Name` | The name of the environment. | Production | | ||
| | `Octopus.Environment.SortOrder` | The order applied to the environment on the dashboard and elsewhere. | `3` | | ||
| | `Octopus.Environment.State[key]` | The value of an [environment state](/docs/infrastructure/environments/environment-state) entry with the given key. | `#{Octopus.Environment.State[appUrl]}` | |
There was a problem hiding this comment.
Prob want this to match the one listed in the variable dropdown so Octopus.Environment.State[_key_]
There was a problem hiding this comment.
I was thinking it would be better to match the styles in this doc, e.g. Octopus.Environment.MachinesInRole[role] above. It does not really feel necessary to have _ for documentation purpose? The [] should be pretty clear to indicate how to use this variable.
There was a problem hiding this comment.
How does Octopus.Environment.MachinesInRole appear in the variable picker? Having the docs be consistent within themselves is a pretty reasonable result, so long as it's clear which you are right it prob is with the []
3 participants
Background
BMBB-661 : Support for Environment State is added into Octopus, we should update related doc in Environment and Ephemeral Environment.
What's changed
This PR
How to review
Proof reading is highly appreciated. Please checkout the preview built by CI (after CI shows green tick), recommend starting from
docs/projects/ephemeral-environments#environment-urls, clicking the link to check the doc related to Environment State.