Skip to content
This repository has been archived by the owner on May 3, 2022. It is now read-only.

Commit

Permalink
fixing typos in the documentation (#344)
Browse files Browse the repository at this point in the history
  • Loading branch information
tariq1890 authored and technosophos committed Nov 5, 2018
1 parent 8ee4e2d commit 9622257
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions docs/101-bundle-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ A `bundle.json` is broken down into the following categories of information:
- A specification of which parameters may be overridden, and how those are to be validated
- A list of credentials (name and desired location) that the application needs

There are two formats for a bundle (thin and thick formats). The primary way in which the `bundle.json` file differs is the presence or absence of information in a thick bundle that helps it validate the contents of an image. In a thick bundle, `mediaType` and `size` attributes may assiste the reconstitution of images from the thick format to a runtime format.
There are two formats for a bundle (thin and thick formats). The primary way in which the `bundle.json` file differs is the presence or absence of information in a thick bundle that helps it validate the contents of an image. In a thick bundle, `mediaType` and `size` attributes may assist with the reconstitution of images from the thick format to a runtime format.

For the rest of the documentation, by default we'll be refererring bundles using the "thin" type, but when "thick" bundles become relevant we'll make note that it's a "thick" bundle type.
For the rest of the documentation, by default we'll be referring to bundles using the "thin" type, but when "thick" bundles become relevant we'll make note that it's a "thick" bundle type.

The following is an example of a `bundle.json` for a bundled distributed as a _thin_ bundle:

Expand Down Expand Up @@ -147,7 +147,7 @@ The following fields are informational pieces of metadata designed to convey add
- `keywords`: A list of keywords
- `maintainers`: A list of maintainers, where each maintainer may have the following:
- `name`: Maintainer name
- `email`: Matainer's email
- `email`: Maintainer's email
- `url`: URL to relevant maintainer information

*TODO:* `bundle.json` probably requires a few more top-level fields, such as something about who published it, and something about the license, as well as a bundle api version. A decision on this is deferred until after the PoC
Expand Down Expand Up @@ -257,7 +257,7 @@ TODO: How do we specify URI is a VM image (or Jar or other) instead of a Docker-

The `parameters` section of the `bundle.json` defines which parameters a user (person installing a CNAB bundle) may _override_. Parameter specifications are flat (not tree-like), consisting of name/value pairs. The name is fixed, but the value may be overridden by the user. The parameter definition includes a specification on how to constrain the values submitted by the user.

> The parameters definition is a subset of the ARM template laguage.
> The parameters definition is a subset of the ARM template language.
```json
"parameters": {
Expand Down Expand Up @@ -286,7 +286,7 @@ The `parameters` section of the `bundle.json` defines which parameters a user (p
- metadata: Holds fields that are not used in validation
- description: A user-friendly description of the parameter

Parameter names (the keys in `parameters`) ought to conform to the [Open Group Base Specification Issue 6, Section 8.1, paragraph 4](http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html) definition of environment variable names with one exception: parameter names _may_ begin with a digit (approximately `[A-Z0-9_]+`).
Parameter names (the keys in `parameters`) should ideally conform to the [Open Group Base Specification Issue 6, Section 8.1, paragraph 4](http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html) definition of environment variable names with one exception: parameter names _may_ begin with a digit (approximately `[A-Z0-9_]+`).

For convenience, if lowercase characters are used in parameter names, they will be automatically capitalized. This effectively makes parameter names case-insensitive.

Expand Down
4 changes: 2 additions & 2 deletions docs/102-invocation-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ For example, _base bundles_ may use this directory to store utilities that deriv

### Base Bundles

This section of the specification is non-normative. It describes a pattern for using the contents of one bundle in another bundle as a form of extension or inheritance. While this is non-normative to the specificationm, facilitating this pattern was a goal of CNAB's design.
This section of the specification is non-normative. It describes a pattern for using the contents of one bundle in another bundle as a form of extension or inheritance. While this is non-normative to the specification, facilitating this pattern was a goal of CNAB's design.

The _base bundle pattern_ is a pattern for sharing common bundle tooling across multiple bundles. Succinctly expressed, a _base bundle_ is a bundle whose contents are inherited by another bundle. The most frequent way in which is occurs is when one bundle uses a `Dockerfile` to import another bundle's invocation image in its `FROM` line.

Expand Down Expand Up @@ -104,7 +104,7 @@ The mechanisms for taking a base bundle and creating an extension bundle are not

## Image Construction Files

Including a Dockerfile is _recommended_ for all images built with Docker. It is useful for reproducing a bundle. For other build tools, the build tool's definition may be included instead (e.g. `packer.json` for VM images built with Packer). Any image construction artifacts that are not explicitly allowed in the `/cnbab` directory may be placed in the `/cnab/build` directory.
Including a Dockerfile is _recommended_ for all images built with Docker. It is useful for reproducing a bundle. For other build tools, the build tool's definition may be included instead (e.g. `packer.json` for VM images built with Packer). Any image construction artifacts that are not explicitly allowed in the `/cnab` directory may be placed in the `/cnab/build` directory.

The remainder of this subsection is non-normative.

Expand Down
2 changes: 1 addition & 1 deletion docs/103-bundle-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ None of the actions are required to be implemented. Bundles _ought not_ return e

A CNAB `bundle.json` file may specify zero or more parameters whose values may be specified by a user.

Values that are passed into the container are passed in as environment variables, where each environment variable begins with the prefix `CNAB_P_` and to which the uppercased parameter name is appended. For example `backend_port` will be exposed inside the container as `CNAB_P_BACKEND_PORT`, and thus can be accessed inside of the `run` script:
Values that are passed into the container are passed in as environment variables, where each environment variable begins with the prefix `CNAB_P_` and to which the upper-cased parameter name is appended. For example `backend_port` will be exposed inside the container as `CNAB_P_BACKEND_PORT`, and thus can be accessed inside of the `run` script:

```bash
#!/bin/sh
Expand Down

0 comments on commit 9622257

Please sign in to comment.