Update docs for public preview #736
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
iliana
approved these changes
Feb 14, 2020
tjkirch
force-pushed
the
public-preview
branch
from
6359944
to
278daf9
Compare
|
This push moves the contact section up, per @iliana, and removes the "more details below" link because... everything below is more details. |
samuelkarp
reviewed
Feb 14, 2020
| @@ -284,6 +259,7 @@ The following settings are set for you automatically by [pluto](workspaces/api/) | |||
|
|
|||
| * `settings.updates.metadata-base-url`: The common portion of all URIs used to download update metadata. | |||
| * `settings.updates.target-base-url`: The common portion of all URIs used to download update files. | |||
| * `settings.updates.seed`: A `u32` value that determines how far into in the update schedule this machine will accept an update. We recommending leaving this at its default generated value so that updates can be somewhat randomized in your cluster. | |||
There was a problem hiding this comment.
u32 is a Rust type. Should we say something more descriptive like "An unsigned 32-bit integer value"?
There was a problem hiding this comment.
I think it's a common type or abbreviation for many languages, and it's the least important thing in this sentence, so I don't think it's worth expanding.
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.
I did a pass over our docs to clean them up for public preview. This moves the tenets out to a charter file as well.
Testing done:
Rendered with
gripand read through, and ran through my spell checker.