config: Lead off with the purpose of the config #737
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
wking
force-pushed
the
config-lead-in
branch
2 times, most recently
from
e7b00a4 to
c223790
Compare
|
LGTM |
cyphar
reviewed
Apr 5, 2017
config.md
Outdated
| @@ -1,13 +1,12 @@ | |||
| # <a name="containerConfigurationFile" />Container Configuration file | |||
|
|
|||
| The container's top-level directory MUST contain a configuration file called `config.json`. | |||
There was a problem hiding this comment.
Did you mean to drop this line? Maybe you should include it below the moved paragraph?
There was a problem hiding this comment.
Did you mean to drop this line?
Yes, see “Also drop the config.json existence MUST because” and later. If that is contentious, I can add it back in this PR and file a follow-up PR for its removal.
There was a problem hiding this comment.
this seems like a bizzare flyby. 👎
|
rebase plz |
Instead of leading off with links to a bunch of other places, notes on the Go tags, etc., make things more inviting by leading off with a big-picture summary of what the configuration is about. Signed-off-by: W. Trevor King <[email protected]>
|
Rebased with 0952dd8 → ff071cc, working around the just-landed #756 which I'd spun off this PR earlier :p. |
|
LGTM |
1 similar comment
|
LGTM |
Merged
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.
Instead of leading off with links to a bunch of other places, notes on the Go tags, etc., make things more inviting by leading off with a big-picture summary of what the configuration is about.
Also drop the
config.jsonexistence MUST because:This section defines the configuration format, and doesn't need to be tied to a particular filename.
The bundle spec (in
bundle.md) already has:The
config.mdline may have been useful when it was added (77d44b1). But since thebundle.mdline landed in #210, I think it's been redundant.