Skip to content

Commit

Permalink
Link fixes for Build (knative#867)
Browse files Browse the repository at this point in the history
* Fix links

* Update installing-build-component.md

* Update builder-contract.md

* Update creating-builds.md

* Update builder-contract.md

* Update builds.md

* Update creating-builds.md

* Update installing-build-component.md

* Update installing-build-component.md

* Update creating-builds.md

* Update creating-builds.md

* Update builds.md
  • Loading branch information
carieshmarie authored and RichieEscarez committed Mar 19, 2019
1 parent b3ecadc commit cba85ee
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 15 deletions.
3 changes: 2 additions & 1 deletion docs/build/builder-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ Builders should expect a Build to implement the following conventions:
- `/builder/home`: This volume is exposed to steps via `$HOME`.

- Credentials attached to the Build's service account may be exposed as Git or
Docker credentials as outlined [here](auth/).
Docker credentials as outlined [here](../auth/).


---

Expand Down
16 changes: 9 additions & 7 deletions docs/build/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The `steps` field is required if the `template` field is not defined. You define
one or more `steps` fields to define the body of a build.

Each `steps` in a build must specify a `Builder`, or type of container image
that adheres to the [Knative builder contract](builder-contract/). For each
that adheres to the [Knative builder contract](../builder-contract/). For each
of the `steps` fields, or container images that you define:

- The `Builder`-type container images are run and evaluated in order, starting
Expand All @@ -105,16 +105,17 @@ of the `steps` fields, or container images that you define:
detected.

For details about how to ensure that you implement each step to align with the
"builder contract", see the [`Builder`](builder-contract/) reference topic.
"builder contract", see the [`Builder`](../builder-contract/) reference topic.


#### Template

The `template` field is a required if no `steps` are defined. Specifies a
[`BuildTemplate`](build-templates/) resource object, in which includes
[`BuildTemplate`](../build-templates/) resource object, in which includes
repeatable or sharable build `steps`.

For examples and more information about build templates, see the
[`BuildTemplate`](build-templates/) reference topic.
[`BuildTemplate`](../build-templates/) reference topic.

#### Source

Expand Down Expand Up @@ -147,19 +148,20 @@ that is in the
of the `Build` resource object.

For examples and more information about specifying service accounts, see the
[`ServiceAccount`](auth/) reference topic.
[`ServiceAccount`](../auth/) reference topic.


#### Volumes

Optional. Specifies one or more
[volumes](https://kubernetes.io/docs/concepts/storage/volumes/) that you want to
make available to your build, including all the build steps. Add volumes to
complement the volumes that are implicitly
[created during a build step](builder-contract/).
[created during a build step](../builder-contract/).

For example, use volumes to accomplish one of the following common tasks:

- [Mount a Kubernetes secret](auth/).
- [Mount a Kubernetes secret](../auth/).

- Create an `emptyDir` volume to act as a cache for use across multiple build
steps. Consider using a persistent volume for inter-build caching.
Expand Down
12 changes: 6 additions & 6 deletions docs/build/creating-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ uses [busybox](https://docs.docker.com/samples/library/busybox/) to simply print
"_hello build_".

Tip: See the
[build code samples](builds/#get-started-with-knative-build-samples) for
[build code samples](../builds/#get-started-with-knative-build-samples) for
examples of more complex builds, including code samples that use container
images, authentication, and include multiple steps.

Expand All @@ -24,17 +24,17 @@ Before you can run a Knative Build, you must have Knative installed in your
Kubernetes cluster, and it must include the Knative Build component:

- For details about installing a new instance of Knative in your Kubernetes
cluster, see [Installing Knative](../install/).
cluster, see [Installing Knative](../../install/).

- If you have a component of Knative installed and running, you must
[ensure that the Knative Build component is also installed](installing-build-component/).
[ensure that the Knative Build component is also installed](../installing-build-component/).

## Creating and running a build

1. Create a configuration file named `build.yaml` that includes the following
code.

This `Build` resource definition includes a single "[step](builds/#steps)"
This `Build` resource definition includes a single "[step](../builds/#steps)"
that performs the task of simply printing "_hello build_":

```yaml
Expand All @@ -52,7 +52,7 @@ Kubernetes cluster, and it must include the Knative Build component:
Notice that this definition specifies `kind` as a `Build`, and that the name
of this `Build` resource is `hello-build`. For more information about
defining build configuration files, See the
[`Build` reference topic](builds/).
[`Build` reference topic](../builds/).

1. Deploy the `build.yaml` configuration file and run the `hello-build` build on
Knative by running the
Expand Down Expand Up @@ -164,7 +164,7 @@ Kubernetes cluster, and it must include the Knative Build component:

To learn more about the objects and commands used in this topic, see:

- [Knative `Build` resources](builds/)
- [Knative `Build` resources](../builds/)
- [Kubernetes Init containers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)
- [Kubernetes kubectl CLI](https://kubernetes.io/docs/reference/kubectl/kubectl/)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/installing-build-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To add only the Knative Build component to an existing installation:
time. Use CTRL + C to exit watch mode.

You are now ready to create and run Knative Builds, see
[Creating a simple Knative Build](creating-builds/) to get started.
[Creating a simple Knative Build](../creating-builds/) to get started.

---

Expand Down

0 comments on commit cba85ee

Please sign in to comment.