Commit Graph

56 Commits

Author SHA1 Message Date
Vincent Batts 3db55ea3ba *: fetch code-of-conduct.md from tob (#413)
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-05-02 14:04:54 -04:00
Rob Dolin (MSFT) d791113001 [ReadMe] Consistent indented portions of Table of Contents
Signed-off-by: Rob Dolin <RobDolin@microsoft.com>
2016-04-26 15:33:33 -07:00
Vincent Batts 48428a49ff Merge pull request #375 from RobDolinMS/patch-11
ReadMe: Link to shared Code of Conduct in TOB repo
2016-04-20 13:36:36 -04:00
Mrunal Patel 3eeb4ff068 Merge pull request #376 from hqhq/hq_add_project
Add project.md to table of contents
2016-04-13 10:36:41 -07:00
Qiang Huang 839ee37068 Merge pull request #378 from vbatts/robdolin_pr368
README: clarify weekly call
2016-04-13 11:26:57 +08:00
Qiang Huang fb230df326 Add project.md to table of contents
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2016-04-12 15:16:10 +08:00
W. Trevor King 55b3dc23f7 README: Remove trailing whitespace
With:

  $ sed -i 's/[[:space:]]*$//' README.md

fixing some trailing whitespace that snuck in with ca0803d1
(Additional language for conformance statement, 2016-04-06, #374).
Future occurrences should be caught by git-validation, which checks
for whitespace issues since [1,2].

[1]: https://github.com/vbatts/git-validation/pull/7
[2]: https://github.com/vbatts/git-validation/pull/9

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-04-11 20:59:42 -07:00
Rob Dolin (MSFT) 524d101d7e README: clarify weekly call
Weekly call is for all OCI projects and per discussion on today's call,
updates to indicate the call is for all OCI projects (rather than having
multiple calls.)

And updates time zone description from PST/PDT to Pacific time

Signed-off-by: Rob Dolin <RobDolin@microsoft.com>
2016-04-11 23:18:36 -04:00
Rob Dolin (MSFT) b05cbff7a7 ReadMe: Link to shared Code of Conduct in TOB repo
Signed-off-by: Rob Dolin <RobDolin@microsoft.com>
2016-04-07 17:37:17 -07:00
Stephen Walli ca0803d131 Additional language for conformance statement
Proposed additional conformance language to support future certification work (cribbed from https://tools.ietf.org/html/rfc2616).

Signed-off-by: Stephen R. Walli <stephen.walli@gmail.com>
2016-04-07 15:55:51 -07:00
W. Trevor King e0525bcbd9 style: Move one-sentence-per-line rule over from the README
This is style information, even though it's about the spec and not
about the behavior covered by the spec.  The Go-pointer rule is also
about more peripheral stuff though, and the README has a lot of stuff
in it, so it seems like a better fit after the move.

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-04-06 11:19:05 -07:00
Vincent Batts faad7e0fcf README: title rename
And align wording with
https://github.com/opencontainers/image-spec/pull/5

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-04-05 13:24:40 -04:00
Vincent Batts 207267d0de *: specs -> runtime-spec
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-04-04 14:16:01 -04:00
W. Trevor King ab61f5db8b README: Add a link to the IRC logs
We have these irclog2html.py logs because we're part of a MeetBot pool
managed by the Linux Foundation [1], so they should be pretty
reliable.

We could have this link in the /topic, but there's already a lot there
and folks may want to browse the logs over HTTP without bothering to
connect to the live channel.

[1]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/%23opencontainers.2015-12-29.log.html#t2015-12-29T21:51:30

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-03-30 09:15:31 -07:00
Michael Crosby dfd71f755e Merge pull request #337 from vbatts/carry-335
ReadMe: Update content to match print order
2016-03-09 17:03:57 -08:00
W. Trevor King ccc7e2fb53 README: Drop BlueJeans link label definition
The only reference was removed in 15a43acd (ReadMe: Replace BlueJeans
with UberConference, 2016-02-24, #326).

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-03-09 11:45:47 -08:00
Rob Dolin (MSFT) 4288244a89 ReadMe: Update content to match print order
Update the Table of Contents section of the ReadMe.md to match the order
of the merged MarkDown files in the printable HTML and PDF outputs

Signed-off-by: Rob Dolin <RobDolin@microsoft.com>
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-03-09 14:12:59 -05:00
Rob Dolin (MSFT) 15a43acd26 ReadMe: Replace BlueJeans with UberConference
BlueJeans requires a moderator while UberConference does not

Signed-off-by: Rob Dolin <robdolin@microsoft.com>
2016-02-24 10:23:05 -08:00
W. Trevor King cb2da5430a config: Single, unified config file
Reverting 7232e4b1 (specs: introduce the concept of a runtime.json,
2015-07-30, #88) after discussion on the mailing list [1].  The main
reason is that it's hard to draw a clear line around "inherently
runtime-specific" or "non-portable", so we shouldn't try to do that in
the spec.  Folks who want to flag settings as non-portable for their
own system are welcome to do so (e.g. "we will clobber 'hooks' in
bundles we run") are welcome to do so, but we don't have to have
to split the config into multiple files to do that.

There have been a number of additional changes since #88, so this
isn't a pure Git reversion.  Besides copy-pasting and the associated
link-target updates, I've:

* Restored path -> destination, now that the mount type contains both
  source and target paths again.  I'd prefer 'target' to 'destination'
  to match mount(2), but the pre-7232e4b1 phrasing was 'destination'
  (possibly due to Windows using 'target' for the source?).

* Restored the Windows mount example to its pre-7232e4b1 content.

* Removed required mounts from the config example (requirements landed
  in 3848a238, config-linux: specify the default devices/filesystems
  available, 2015-09-09, #164), because specifying those mounts in the
  config is now redundant.

* Used headers (vs. bold paragraphs) to set off mount examples so we
  get link anchors in the rendered Markdown.

* Replaced references to runtime.json with references to config.json.

[1]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/0QbyJDM9fWY
     Subject: Single, unified config file (i.e. rolling back specs#88)
     Date: Wed, 4 Nov 2015 09:53:20 -0800
     Message-ID: <20151104175320.GC24652@odin.tremily.us>

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-01-27 09:51:54 -08:00
Vish Kannan 72e7cf9daf Merge pull request #280 from philips/try-and-add-some-use-cases
README: add some user stories
2016-01-19 12:57:00 -08:00
Brandon Philips 9289afe113 README: add runtime, bundle, and hook author user
Lets call out some users directly and give them titles. Then define what
they is trying to do.

Signed-off-by: Brandon Philips <brandon.philips@coreos.com>
2016-01-19 12:23:42 -08:00
W. Trevor King 408412ba80 style: Collect established styles in a discoverable location
So we have something to cite to avoid rehashing established decisions.
Provide some motivation and links to the backing discussion so folks
can re-open these if they have new information that wasn't covered in
the original decision.

Like the glossary (18734986, glossary: Provide a quick overview of
important terms, 2015-08-11, #107), I've used subsection titles for
each entry to get link anchors.

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-01-05 13:31:29 -08:00
Brandon Philips bcb459c1c7 README: make use cases less loud
I am going to add some additional use cases so lets move to h4 instead
of an h2.

Signed-off-by: Brandon Philips <brandon.philips@coreos.com>
2015-12-23 17:05:37 -08:00
W. Trevor King 18734986bc glossary: Provide a quick overview of important terms
And link them to the more detailed specification.

Subsection titles for the entries will be obnoxiously spacious, but
the other alternatives seem worse:

a. An HTML definition list (<dl>) would have nice default styling, but
   it's annoying to write raw HTML.  And we would have needed
   something like:

     <dt name="bundle">Bundle</dt>
     <dd>

     A [directory structure](bundle.md) that is...

     </dd>

   to get Markdown-style links in the defintion itself.

b. A Markdown list (* ...) would have reasonable default styling, but
   there's no Markdown syntax for adding anchors to the entries.  And
   a glossary is much less useful if you can't link to a specific
   entry.

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-23 09:27:30 -08:00
Mrunal Patel 72ba8bf82e Merge pull request #272 from vbatts/roadmap-link
roadmap: update links and add wiki reference
2015-12-17 09:40:21 -08:00
Vincent Batts b7a4db3146 roadmap: update links and add wiki reference
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-12-16 16:37:50 -05:00
Mike Brown 57a196a0a0 adds text describing the upper-case keywords used in the spec
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2015-12-04 09:32:23 -06:00
Zefan Li 3d789d74a8 README: Fix some headers
Signed-off-by: Zefan Li <lizefan@huawei.com>
2015-10-08 15:33:09 +08:00
Michael Crosby b0bbf989fb Update readme with wiki link to minutes
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-10-05 12:52:50 -07:00
Vincent Batts 70372d3880 *.md: update TOC and links
Some of the docs were not even linked to, and did not have a logic
outline for their grouping.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-25 11:47:16 -04:00
Vincent Batts a28afa1058 principles: Give principles their own home
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-18 10:40:26 -04:00
Vincent Batts dbac706bac README: make header more concise
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-18 10:39:51 -04:00
Mrunal Patel f6ec7a75c6 Merge pull request #168 from vbatts/git-style-guide
README.md: adding a git style guide
2015-09-11 13:26:32 -07:00
Vincent Batts 82835aa2a4 README.md: Add a git commit style guide
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-11 16:23:54 -04:00
Vincent Batts d335ecd6df README: releases section
As we ready for a draft release, verbiage is needed on what this
pre-release means.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-10 16:18:09 -04:00
Vincent Batts 6cab2747d9 *.md: markdown formatting
Closes https://github.com/opencontainers/specs/issues/83

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-09 10:17:06 -04:00
Vincent Batts 1cdec7c066 *: adding a code of conduct
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-04 13:15:17 -04:00
Michael Crosby 6a5a445465 Merge pull request #116 from wking/bluejeans-meetings
README: Document BlueJeans for meetings
2015-08-28 11:06:35 -07:00
W. Trevor King 4cc06a6a8b README: Document BlueJeans and wiki archive for meetings
In #opencontainers after today's meeting, here's the source for the
change from Google Hangouts to BlueJeans:

12:01 < wking> Is the BlueJeans approach going to be our standard
  procedure?  If so, I can file a PR updating our weekly-meeting docs
  (which still talk about YouTube and Google Hangouts)
12:03 < mrunalp> wking: Yeah, I think so.
12:04 < wking> ok.  And it's just going to "push the BlueJeans link to
  IRC and the list before the meeting"?  Or does BlueJeans have stable
  channel URLs or similar?
12:05 < mrunalp> wking: The URL that we used today is stable.

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-08-26 15:22:32 -07:00
W. Trevor King a48397b9eb Remove trailing whitespace
With:

  $ sed -i 's/  *$//' *.md *.go

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-08-26 15:14:19 -07:00
Vincent Batts 7e22d0d6f7 README.md: contribution about discussion
Leaning on aspects of golang's contribution
(https://golang.org/doc/contribute.html)

Signed-off-by: Vincent Batts <vbatts@redhat.com>
2015-08-12 13:30:22 -04:00
W. Trevor King 6ef382b69c README: Document YouTube and IRC backchannel for meetings
On Mon, Aug 10, 2015 at 09:38:50AM -0700, Mrunal Patel wrote [1]:
> There is a limit of 10 participants per hangout. So, I will
> broadcast it at the time when it starts and people who aren't
> invited could view the stream and discuss on IRC.

On Mon, Aug 10, 2015 at 09:53:59AM -0700, Mrunal Patel wrote [2]:
> I think the youtube channel should work as the broadcast link
> https://www.youtube.com/channel/UC1wmLdEYmwWcsFg7bt1s5nw

The IRC channel location is from opencontainers/web@f693390f (updated
content, 2015-06-21).

[1]: https://groups.google.com/a/opencontainers.org/d/msg/dev/Cy5uFI_ySpg/E1FnYUmfDwAJ
     From: Mrunal Patel
     Subject: Re: Discussions and Notes
     Date: Mon, 10 Aug 2015 09:38:50 -0700
     Message-ID: <CANEZBD7K=8+i7RaTAkg_0XLUSQrZLykGR0bxce-JtErO8KAQ1Q@mail.gmail.com>
     Cc: dev <dev@opencontainers.org>, ...
[2]: https://groups.google.com/a/opencontainers.org/d/msg/dev/Cy5uFI_ySpg/X4RQEx2gDwAJ
     From: Mrunal Patel
     Subject: Re: Discussions and Notes
     Date: Mon, 10 Aug 2015 09:53:59 -0700
     Message-ID: <CANEZBD7snSro5GXYc6QRuk3+KnR0WAeFThfQXvOcnx3t9jNXag@mail.gmail.com>
     Cc: dev <dev@opencontainers.org>, ...

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-08-10 10:15:03 -07:00
W. Trevor King f9bf5c1b55 README: Document pre-meeting agenda alteration
On Wed, Aug 05, 2015 at 11:57:59AM -0700, Mrunal Patel wrote [1]:
> We could also have guests on the hangout if they have some important
> topic to present. We can decide that on the topics being discussed
> in the mailing list.

On Sat, Aug 08, 2015 at 08:23:21AM -0400, Vincent Batts wrote [2]:
> We said the topics would be proposed on this list. Discussion notes have
> been shared as a Google doc so far. I'm not opposed to markdown notes, but
> initially that just seems like an repo to me.

More generally, the topic of feedback loops came up in the 2015-08-05
meeting [3,4] (after 26:02 in the video), and the consensus was to
start discussion anything that seemed worth discussion on the mailing
list ("conversations and discussions should be on
dev@opencontainers.org mailing-list first, conversations and
discussions should be on dev@opencontainers.org" [3]).  That doesn't
speak to agenda-formation specifically, but it makes an official
policy of discussing most things on the mailing list, and the two
posts I quote above extend that general approach to agenda formation.

While touching this paragraph, I also re-wrapped it to match
README.md#markdown-style.

[1]: https://groups.google.com/a/opencontainers.org/d/msg/dev/JsXgi4kxkBg/Gw7GvPodDgAJ
     From: Mrunal Patel
     Subject: Re: Hangout link for today
     Date: Wed, 5 Aug 2015 11:57:59 -0700
     Message-ID: <CANEZBD6Zs5Ht8dgkvSHRHQGaVLms_kSGqCV00AJD6eFLm9hR4w@mail.gmail.com>
     Cc: dev <dev@opencontainers.org>, …
[2]: https://groups.google.com/a/opencontainers.org/d/msg/dev/41jZ9Qe7R5c/ZInajC_0DgAJ
     From: Vincent Batts
     Subject: Re: Open Container Weekly Meeting - Aug 5, 2015
     Date: Sat, 8 Aug 2015 08:23:21 -0400
     Message-ID: <CAN6Zp5yFX8yLG3b-82SAq7AmCxVpoy1tyt0K1ijFqSsCjKPRpg@mail.gmail.com>
     Cc: dev <dev@opencontainers.org>, …
[3]: https://docs.google.com/document/d/1a5UW7MRLVaUDEjuQmRudYMZcPV0bBtPD2QEOLT_3zi0/edit?usp=sharing
[4]: https://plus.google.com/events/cqfpicicbnra9mv6kvpj0mb24u4

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-08-08 16:30:06 -07:00
Vincent Batts b3ebf849bf .: Adding listing of implementations
* runc
* runv - https://groups.google.com/a/opencontainers.org/d/msg/dev/Tjq5QJ_eez0/LMt3dgReDQAJ
* ocp-testing - https://groups.google.com/a/opencontainers.org/d/msg/dev/_XUjuKzL84g/i2n5s0iUBgAJ

Signed-off-by: Vincent Batts <vbatts@redhat.com>
2015-08-07 13:18:13 -04:00
Vincent Batts 9ed6de6631 Merge pull request #85 from philips/bundle-use-case
bundle: add initial run use case
2015-07-31 22:08:14 -04:00
Brandon Philips 4b90d6bed4 bundle: add initial run use case
Signed-off-by: Brandon Philips <brandon.philips@coreos.com>
2015-07-30 11:54:17 -07:00
Michael Crosby 36deacd0b2 Update readme with weekly call and mailing list
This adds information for new participants to join the mailing list and
weekly meeting.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-07-29 11:30:53 -07:00
Brandon Philips 1075520709 README: add a rule for paragraph formatting in markdown 2015-07-28 17:37:29 -07:00
Lai Jiangshan 012bf95040 spec: rename ocp to oci and add a link
Signed-off-by: Lai Jiangshan <jiangshanlai@gmail.com>
2015-07-26 16:24:01 +08:00
Michael Crosby 84707b0843 Add license and DCO information for contributions
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-07-02 13:56:14 -07:00