Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adjust filesnames to match associated JSON #126

Closed
wants to merge 11 commits into from
Closed

Adjust filesnames to match associated JSON #126

wants to merge 11 commits into from

Commits on Aug 30, 2015

  1. Rename Go and Markdown files to match their associated JSON 

    Before this commit we had the following mapping:

* config.md → config.go (config.json)
* config-linux.md → config_linux.go (config.json's "linux")
* runtime-config.md → runtime_config.go (runtime.json)
* runtime.md → lifecycle and runtime_config.go (runtime.json's
  "prestart" and "poststop" hooks)
* runtime-config-linux.md → runtime_config_linux.go (runtime.json's
  "linux")

This commit:

* replaces underscores with hyphens, and:
* renames Go and Markdown files

so:

* the docs for ${X}.json are in ${X}.md
* the platform-independent types for ${X}.json are in ${X}.go
* the docs for ${X}.json's ${PLATFORM} section are in
  ${X}-${PLATFORM}.md
* the platform-dependent types for ${X}.json's ${PLATFORM} section are
  in ${X}-${PLATFORM}.go

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    4d30c41 View commit details
    Browse the repository at this point in the history

  2. Move hooks from lifecycle.md to runtime.md 

    Hooks are only valid in runtime.json, so we should discuss them in the
runtime.json docs.  I'll add appropriate links from the lifecycle docs
in a bit, but linking into runtime.json is poor enough that I think it
deserves its own commit.  The only change here besides the copy/paste
is the addition of a blank line after the Markdown headers to match
the rest of the documentation.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    4cfa584 View commit details
    Browse the repository at this point in the history

  3. bundle.md: Link to the runtime.json docs 

    Just like we link to the config.json docs.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    c5305f9 View commit details
    Browse the repository at this point in the history

  4. README: Link to the runtime.json docs 

    Just like we link to the config.json docs.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    fcd496c View commit details
    Browse the repository at this point in the history

  5. lifecycle: Add a list outlining the usual flow 

    Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    8dae07a View commit details
    Browse the repository at this point in the history

  6. lifecycle: Add an explicit container-destroy step 

    It doesn't make sense to split creation into "create" and "start"
while only having one "stop" command for both the application and
container teardown.
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    7d6e8b3 View commit details
    Browse the repository at this point in the history

  7. README: Change 'Linux Specific' -> 'Linux-specific' 

    To match 'Host-specific' and 'Host-independent'.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    1c55c3c View commit details
    Browse the repository at this point in the history

  8. config: Mention host-independent in headings 

    To distinguish from the host-dependent runtime.json configuration.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    c65526f View commit details
    Browse the repository at this point in the history

  9. lifecycle: Cross-link the generic and Linux-specific notes 

    Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    e74f66f View commit details
    Browse the repository at this point in the history

  10. runtime: Cross-link the generic and Linux-specific notes 

    And add top-level headings for these files.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    07e052f View commit details
    Browse the repository at this point in the history

  11. lifecycle: Drop 'Runtime and Lifecycle' top heading 

    This page is just about the lifecycle now.  I'm not sure what the
original intention was, but when this header landed in runtime.md with
5d2eb18 (*: re-org the spec, 2015-06-24) there wasn't anything beyond
the lifecycle stuff in this file.  Now that it's lifecycle.md and
there are other files for our other content, I don't expect it to talk
about anything besides the lifecycle in the future.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Aug 30, 2015
    Configuration menu
    Copy the full SHA
    e22af5d View commit details
    Browse the repository at this point in the history