docs(rclone): Update storage secrets docs with expectations and details on usage #4969
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
Use shorter sentences. Clarify usage expectations. Explain the basic mechanism and reference how users can use this themselves.
This is both consistent with the nomenclature in the page and with Deploy docs, but is also more accurate, as it is about the configuration and credentials for remote storage locations, not about cloud storage at large.
agrski
changed the title
Also update wording to clarify the use of these.
ukclivecox
approved these changes
Jul 5, 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:
The existing docs on using storage secrets (Rclone configurations) with Core v2 are somewhat sparse and do not properly clarify requirements and expectations.
This PR aims to provide more comprehensive documentation, including referencing the appropriate values to update in a
SeldonRuntimeresource for shared/global pre-loaded secrets.Which issue(s) this PR fixes:
Fixes #4947
Special notes for your reviewer:
N/A