search

coreos / butane

Butane translates human-readable Butane Configs into machine-readable Ignition Configs.
https://coreos.github.io/butane/
Apache License 2.0
255 stars 70 forks source link

docs: Fix 'config' mention in 'hash' docs #387

Closed travier closed 1 year ago

travier commented 2 years ago

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 https://github.com/coreos/ignition/issues/961 ?

bgilbert commented 2 years ago

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 compression is specified, the hash describes the decompressed contents" SGTM.

bgilbert commented 2 years ago

Also, we typically release-note changes to the spec docs, even if they're minor clarifications.

bgilbert commented 2 years ago

@travier, are you planning to handle updating this?

travier commented 2 years ago

I need to update it and sync it with the Ignition docs. Open to someone else picking it up.

travier commented 1 year ago

Thanks @prestist !