[RPD-272] Updates to documentation #166
Merged
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
Christopher-Norman
requested changes
Jul 20, 2023
JonoCX
added a commit
that referenced
this pull request
Jul 28, 2023
* [RPD-261] [BUG] destroy leads to missing matcha config file error (#165) * Update context managers to avoid erroring on destroy after remote bucket is removed * Update docstrings * Add tests for context managers new destroy parameter * [RPD-272] Updates to documentation (#166) * RPD-272 updates to pages based on ticket description * RPD-272 updated permissions * [RPD-276] [BUG] Turning analytics on causes hanging in the analytics service (#168) * [RPD-271] [BUG] Fix orphaned NetworkWatcherRG resource group (#167) * [RPD-279] [BUG] Automatically deal with stale states #170 * [RPD-273] Improvements to the `provision` user experience (#173) * RPD-273 added a terraform state update function and minor improvements to terraform service * RPD-273 updated typing and fixed pre-commit issues * RPD-273 undoing a change to the gitignore * RPD-273 updated docstrings + grammar * RPD-272 updated typing on context manager for Spinner * [RPD-274] [BUG] Fix inaccurate provisioning messages (#177) * Update message on Terraform apply for clarity * Update test with new message * Update base_runner.py * Fix test * Revert message parameter to empty string * [RPD-263] add inference of zenml version from environment (#178) * function checking local zenml version. * function checking local zenml version. * function checking local zenml version. * remove return from ds as there is none --------- Co-authored-by: Jonathan Carlton <[email protected]> Co-authored-by: KirsoppJ <[email protected]>
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.
There are a few minor improvements that can be made to the documentation:
Getting Started
Remove references tomatcha destroy fullReferences to the
fullcommand don't appear in the documentation.matchawill tell you what permissions you needAzure Permissions
OwnerOR `Contributor + User Access AdministratorDeploying your first model
The focus is actually training and deploying your first modelThe language is clear enough as training is stated throughout the page and it's about getting started with deploying more generally so I don't think this change needs to be made.
Checklist
Please ensure you have done the following:
Type of change
Tick all those that apply: