docs(api): Add additional docs to describe behaviour of model redeployment #478
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
deadlycoconuts
added
the
documentation
deadlycoconuts
requested review from
ariefrahmansyah,
krithika369,
leonlnj and
tkpd-hafizhan
deadlycoconuts
commented
Oct 25, 2023
| becomes the current *deployment* of the model version. | ||
|
|
||
| If the deployment of the new configuration fails, **the old deployment stays deployed** and remains as the current | ||
| *deployment* of the model version. The new configuration will then show a 'Failed' status. |
There was a problem hiding this comment.
I'm thinking of adding some screenshots of the UI here to show the new deployment history panel but I don't think it's absolutely necessary here because the rest of the docs don't really show screenshots of the UI. We can still do this for a start and add UI screenshots for the rest of the docs subsequently too. What do you all think?
There was a problem hiding this comment.
I think one ss here here will do
There was a problem hiding this comment.
Okay, I'll see what I can find and add one here.
deadlycoconuts
changed the title
leonlnj
reviewed
Oct 25, 2023
krithika369
reviewed
Oct 25, 2023
|
Okay I've just addressed the comments in this PR. Thanks a lot for the reviews! |
leonlnj
approved these changes
Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR introduces some additional user documentation to describe the new behaviour when redeploying model versions in Merlin.
Which issue(s) this PR fixes:
None
Fixes #
Does this PR introduce a user-facing change?:
Checklist