docs: Fix 'config' mention in 'hash' docs #387
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
|
How do we feel about adding a note like "If compression is set, then the hash is for the decompressed content" to all of those instances for coreos/ignition#961 ? |
|
Let's aim to keep the Butane spec docs in sync with the Ignition ones. The Ignition spec docs opted for "the hash of the contents", which is a little clearer in the context of the spec. "If |
|
Also, we typically release-note changes to the spec docs, even if they're minor clarifications. |
|
@travier, are you planning to handle updating this? |
|
I need to update it and sync it with the Ignition docs. Open to someone else picking it up. |
prestist
force-pushed
the
hash-files
branch
3 times, most recently
from
def7bc0
to
2414219
Compare
bgilbert
reviewed
Mar 3, 2023
prestist
force-pushed
the
hash-files
branch
3 times, most recently
from
851f0e7
to
e1af6ef
Compare
prestist
changed the title
prestist
force-pushed
the
hash-files
branch
3 times, most recently
from
0e16803
to
543e55f
Compare
bgilbert
reviewed
Mar 3, 2023
bgilbert
reviewed
Mar 3, 2023
Additionally clarify that `hash` fields describe the decompressed contents. Co-authored-by: Timothée Ravier <tim@siosm.fr>
bgilbert
approved these changes
Mar 4, 2023
|
Thanks @prestist ! |
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.
No description provided.