Skip to content

Clean-up spec to remove non-spec-ish items#458

Merged
vbatts merged 1 commit into
opencontainers:masterfrom
duglin:specCleanup
Dec 1, 2016
Merged

Clean-up spec to remove non-spec-ish items#458
vbatts merged 1 commit into
opencontainers:masterfrom
duglin:specCleanup

Conversation

@duglin

@duglin duglin commented Nov 16, 2016

Copy link
Copy Markdown
Collaborator

Per the oci f2f at kubecon. Similar changes what is in: opencontainers/runtime-spec#626

Signed-off-by: Doug Davis dug@us.ibm.com

Comment thread spec.md
- [Notational Conventions](#notational-conventions)
- [Overview](#overview)
- [Understanding the Specification](#understanding-the-specification)
- [Media Types](media-types.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indent? You should replace the earlier tab with four spaces (opencontainers/runtime-spec#495).

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@wking

wking commented Nov 16, 2016

Copy link
Copy Markdown
Contributor

I think this is a step in the right direction, although it will
conflict with a few open PRs against this language (#455, #456).

I also think we should merge the “Overview” and “Understanding the
Specification” sections 1, but that can happen in follow-up work if
you don't want to address it here. Pulling out “Notational
Conventions”, like you've done here, will make future merging easier.

@philips

philips commented Nov 17, 2016

Copy link
Copy Markdown
Contributor

LGTM

Approved with PullApprove

Comment thread manifest-list.md
```

[runtime-platform]: https://github.com/opencontainers/runtime-spec/blob/v1.0.0-rc2/config.md#platform
[runtime-platform2]: https://github.com/opencontainers/runtime-spec/blob/v1.0.0-rc2/config.md#platform

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why rename this?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current approach to single-file PDF/HTML generation is to feed all the Markdown into Pandoc. Pandoc seems to treat them as a single, concatenated file internally and doesn't like seeing the same reference defined more than once, so he's giving this a globally-unique name to avoid conflicting with the entry in config.md.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gah, what a mess. I really just want to drop PDF/HTML.

@vbatts

vbatts commented Nov 30, 2016

Copy link
Copy Markdown
Member

@duglin rebase please?

@duglin

duglin commented Nov 30, 2016

Copy link
Copy Markdown
Collaborator Author

rebased, but I'd appreciate a double-check to make sure I didn't drop anything from README.md or spec.md.

@jonboulle

Copy link
Copy Markdown
Contributor

Conflicts again

Signed-off-by: Doug Davis <dug@us.ibm.com>
@duglin

duglin commented Dec 1, 2016

Copy link
Copy Markdown
Collaborator Author

rebased

@jonboulle

jonboulle commented Dec 1, 2016

Copy link
Copy Markdown
Contributor

lgtm I suppose

Approved with PullApprove

@vbatts

vbatts commented Dec 1, 2016

Copy link
Copy Markdown
Member

LGTM

Approved with PullApprove

@vbatts
vbatts merged commit 241dd68 into opencontainers:master Dec 1, 2016
wking added a commit to wking/image-spec that referenced this pull request Dec 10, 2016
This landed in 836fb1c ([ReadMe] Add Compliance Language, 2016-10-11,
opencontainers#432) but was removed in 27508e2 (Clean-up spec to remove
non-spec-ish items, 2016-11-14, opencontainers#458), likely accidentally during a
rebase.

Signed-off-by: W. Trevor King <wking@tremily.us>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants