Commit Graph

76 Commits

Author SHA1 Message Date
Jesse Butler f9dc90b05a make link usage consistent across the specification
Signed-off-by: Jesse Butler <jesse.butler@oracle.com>
2017-03-03 14:43:09 -05:00
W. Trevor King 200e86f8ef README: Consistent header nesting
And add a header for the Table of Contents.

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-01-11 15:27:44 -08:00
Doug Davis e7be40f0c3 Cleanup the spec a bit to remove WG/git text that's not really part of the spec
renamed an href to "container-namespace2" to avoid a dup-warning msg from
the PDF generator

Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-16 09:50:03 -08:00
Qiang Huang 600b8b4616 Merge pull request #619 from wking/tk/process-header
config: Change “Process configuration” → “Process” header
2016-11-15 14:33:21 +08:00
Daniel, Dao Quang Minh 780fc67f04 Merge pull request #622 from wking/rfc-2119-wording
README: Use recommended RFC 2119 wording
2016-11-14 18:08:49 -08:00
Jonathan Boulle 4476954bbd README: remove extraneous apostrophe
Also s/OpenContainers/OCI/ as used in the image-spec README.

Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
2016-11-15 10:13:21 +09:00
W. Trevor King af7a94dbfe README: Use recommended RFC 2119 wording
Match the recommendation in the RFC's abstract [1].  Also bump
"keywords" -> "key words" in the subsequent C99 sentence for
consistency.

[1]: https://tools.ietf.org/html/rfc2119

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-11-10 22:29:57 -08:00
W. Trevor King bf9694db6e config: Change "Process configuration" -> "Process" header
All of these sections are about configuration, and we don't usually
use "{Whatever} configuration" in the headers.

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-11-10 20:43:51 -08:00
Qiang Huang 661314a926 Fix several format issues found by pdf and html
This carries #578 and fixes some other format issues.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2016-11-03 09:33:51 +08:00
Vincent Batts 1c7c27d043 Merge pull request #573 from jhowardmsft/jjh/addwindows
Add support for Windows based containers
2016-09-26 16:19:32 -04:00
John Howard dc8f2c2e6e Add support for Windows-based containers
Signed-off-by: John Howard <jhoward@microsoft.com>
2016-09-22 12:13:04 -07:00
John Howard cef511fa6a README: Define 'unspecified', 'undefined', and 'implementation-defined'
Signed-off-by: John Howard <jhoward@microsoft.com>
2016-09-19 13:22:03 -07:00
Jonathan Boulle e641611faf README: tweak title
To be consistent with opencontainers/image-spec.

Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
2016-09-16 14:19:06 +02:00
Rob Dolin (MSFT) 9da89675f5 [ReadMe] Just one level/tier of compliance (rebase)
Signed-off-by: Rob Dolin <robdolin@microsoft.com>
2016-09-01 10:55:01 -07:00
Mrunal Patel 6a5b1449ae Add language for compliance requirements around platforms and architectures
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-08-17 10:44:55 -07:00
W. Trevor King d4bd2dd8da README: Change meeting time from 10am to 2pm Pacific
Catch up with [1] now that we're having 2pm meetings two weeks in a
row.  There's also some earlier discussion in [2].

[1]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/VlwOuGh2y84
     Subject: OCI Meeting Times
     Date: Wed, 20 Jul 2016 01:39:33 +1000
     Message-ID: <CAOviyajs3feTFCatETgGPvwy7OubOOWvmJqof0yf1KO540nfHw@mail.gmail.com>
[2]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/HXO-FplpEKM
     Subject: OCI Call Time
     Date: Wed, 1 Jun 2016 21:10:21 +1000
     Message-ID: <591bb0a3-278e-f82c-6514-ff6a35d8d579@suse.de>

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-07-26 14:51:09 -07:00
W. Trevor King 41ff2df25f README: Update conference-call phone number
On Thu, Jul 14, 2016 at 06:27:50PM -0700, Chris Aniszczyk wrote [1]:
> There was a change in the phone number for the conference line, URL
> is the same.
>
> Join the call: https://www.uberconference.com/opencontainers
> Optional dial in number: 415-968-0849
> No PIN needed

[1]: https://github.com/opencontainers/runtime-spec/issues/514

Reported-by: Chris Aniszczyk <caniszczyk@gmail.com>
Signed-off-by: W. Trevor King <wking@tremily.us>
2016-07-14 20:02:59 -07:00
Doug Davis 8d8b26d305 Add a working call-in number
Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-07-06 07:09:22 -07:00
Qiang Huang e137488722 Reference LICENSE file to keep consistency with others
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2016-05-23 09:19:34 +08:00
Abhijeeth Nuthan ebcf9cb653 Adding link in README.md to Solaris configuration.
Signed-off-by: Abhijeeth Nuthan <abhijeeth.nuthan@oracle.com>
2016-05-05 09:17:38 -07:00
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