Skip to content

Makefile: add missing document pages#275

Merged
stevvooe merged 1 commit into
opencontainers:masterfrom
vbatts:add_files_to_docs
Sep 8, 2016
Merged

Makefile: add missing document pages#275
stevvooe merged 1 commit into
opencontainers:masterfrom
vbatts:add_files_to_docs

Conversation

@vbatts
Copy link
Copy Markdown
Member

@vbatts vbatts commented Sep 7, 2016

Closes #244

Signed-off-by: Vincent Batts vbatts@hashbangbash.com

@vbatts vbatts added this to the v0.5.0 milestone Sep 7, 2016
Comment thread Makefile Outdated
serialization.md \
layer.md \
GOVERNANCE.md \
RELEASES.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.

Do we need these last two? I think they're metadata, and not part of the spec itself. runtime-spec does not include them in the generated spec or link to them from any files which are part of the generated spec.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I debated about those two because they are some what boiler plate. I'll
remove them.

On Wed, Sep 7, 2016 at 2:47 PM W. Trevor King notifications@github.com
wrote:

In Makefile
#275 (comment)
:

@@ -26,7 +26,13 @@ DOC_FILES :=
project.md
media-types.md
manifest.md \

  • serialization.md
  • descriptor.md \
  • image-layout.md \
  • serialization.md \
  • layer.md \
  • GOVERNANCE.md \
  • RELEASES.md

Do we need these last two? I think they're metadata, and not part of the
spec itself. runtime-spec does not include them in the generated spec
https://github.com/opencontainers/runtime-spec/blob/22c29c18eddc75ccee9f6b202f61524f29653c5f/Makefile#L23-L38
or link to them from any files which are part of the generated spec.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/opencontainers/image-spec/pull/275/files/13755da234e41fb12131570e58514f5ef7ab7866#r77881516,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEF6Y_jyR2IsQVGlvy89qnc9-Mey352ks5qnwbPgaJpZM4J3Oq0
.

@wking
Copy link
Copy Markdown
Contributor

wking commented Sep 7, 2016

Do we want a table of contents (like runtime-spec has 1)? If so, is
that part of this PR, or a separate issue?

Closes opencontainers#244

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
@philips
Copy link
Copy Markdown
Contributor

philips commented Sep 7, 2016

LGTM

@wking separate issue

Approved with PullApprove

@wking
Copy link
Copy Markdown
Contributor

wking commented Sep 7, 2016

On Wed, Sep 07, 2016 at 01:18:31PM -0700, Brandon Philips wrote:

@wking separate issue

Sounds good. In that case, 3f4c120 looks good to me.

@RobDolinMS
Copy link
Copy Markdown
Collaborator

It would be good to add a Table of Contents as @wking suggests, but I recommend doing that as a another issue/PR so this can be merged. /cc @vbatts

@philips
Copy link
Copy Markdown
Contributor

philips commented Sep 8, 2016

cc @opencontainers/image-spec-maintainers Please LGTM

@stevvooe
Copy link
Copy Markdown
Contributor

stevvooe commented Sep 8, 2016

LGTM

Approved with PullApprove

@stevvooe stevvooe merged commit 0cf32b8 into opencontainers:master Sep 8, 2016
@vbatts vbatts deleted the add_files_to_docs branch September 8, 2016 21:16
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.

5 participants