Skip to content

Commit

Permalink
refactor: flatten the usage docs (#191)
Browse files Browse the repository at this point in the history
  • Loading branch information
Neal committed Jan 12, 2021
1 parent 0f1f311 commit a65d9c9
Show file tree
Hide file tree
Showing 26 changed files with 32 additions and 103 deletions.
@@ -1,7 +1,6 @@
---
title: "Authenticate"
linkTitle: "Authenticate"
weight: 1
description: >
Authenticate to your Vela instance.
---
Expand Down
1 change: 0 additions & 1 deletion content/usage/badge/_index.md → content/usage/badge.md
@@ -1,7 +1,6 @@
---
title: "Badges"
linkTitle: "Badges"
weight: 4
description: >
Show off your build status.
---
Expand Down
@@ -1,7 +1,6 @@
---
title: "Building Docker Images"
toc: true
weight: 7
description: >
Understanding the options for how to build a Dockerfile
---
Expand Down
@@ -1,7 +1,6 @@
---
title: "Enable a Repo"
linkTitle: "Enable a Repo"
weight: 3
description: >
Learn how to add your first repo.
---
Expand Down
@@ -1,7 +1,6 @@
---
title: "Using the Environment"
toc: true
weight: 6
description: >
Learn about how to leverage the environment within your builds.
---
Expand Down
7 changes: 7 additions & 0 deletions content/usage/examples/_index.md
@@ -0,0 +1,7 @@
---
title: "Examples"
toc: true
weight: 2
description: >
View example pipelines for a quick start.
---
Expand Up @@ -3,10 +3,10 @@ title: "Go (With Modules)"
toc: true
weight: 1
description: >
Sample Go (With Modules) Pipeline
Example Go (With Modules) Pipeline
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project building a [Go](https://golang.org/) binary with [Go modules](https://github.com/golang/go/wiki/Modules).
Example [Yaml](https://yaml.org/spec/) configuration for a project building a [Go](https://golang.org/) binary with [Go modules](https://github.com/golang/go/wiki/Modules).

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Java (With Gradle)"
toc: true
weight: 2
description: >
Sample Java (With Gradle) Pipeline
Example Java (With Gradle) Pipeline
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project building a [Java](https://docs.oracle.com/en/java/) application with [Gradle](https://docs.gradle.org/current/userguide/userguide.html).
Example [Yaml](https://yaml.org/spec/) configuration for a project building a [Java](https://docs.oracle.com/en/java/) application with [Gradle](https://docs.gradle.org/current/userguide/userguide.html).

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Java (With Maven)"
toc: true
weight: 2
description: >
Sample Java (With Maven) Pipeline
Example Java (With Maven) Pipeline
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project building a [Java](https://docs.oracle.com/en/java/) application with [Maven](https://maven.apache.org/guides/index.html).
Example [Yaml](https://yaml.org/spec/) configuration for a project building a [Java](https://docs.oracle.com/en/java/) application with [Maven](https://maven.apache.org/guides/index.html).

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Mongo"
toc: true
weight: 1
description: >
Sample Pipeline with Mongo
Example Pipeline with Mongo
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project requiring a [Mongo](https://www.mongodb.com/) as a pipeline dependency.
Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a [Mongo](https://www.mongodb.com/) as a pipeline dependency.

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Node"
toc: true
weight: 3
description: >
Sample Node Pipeline
Example Node Pipeline
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project building a [Node](https://nodejs.org/en/docs/) application.
Example [Yaml](https://yaml.org/spec/) configuration for a project building a [Node](https://nodejs.org/en/docs/) application.

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Postgres"
toc: true
weight: 1
description: >
Sample Pipeline with Postgres
Example Pipeline with Postgres
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project requiring a [Postgres](https://www.postgresql.org/) as a pipeline dependency.
Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a [Postgres](https://www.postgresql.org/) as a pipeline dependency.

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Redis"
toc: true
weight: 1
description: >
Sample Pipeline with Redis
Example Pipeline with Redis
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project requiring a [Redis](https://redis.io/) as a pipeline dependency.
Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a [Redis](https://redis.io/) as a pipeline dependency.

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Route"
toc: true
weight: 1
description: >
Sample Pipeline with build routing
Example Pipeline with build routing
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project requiring a specific runtime or platform.
Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a specific runtime or platform.

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Rust (With Cargo)"
toc: true
weight: 1
description: >
Sample Rust (With Cargo) Pipeline
Example Rust (With Cargo) Pipeline
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project building a [Rust](https://www.rust-lang.org/) binary with [Cargo](https://doc.rust-lang.org/cargo/commands/cargo-doc.html).
Example [Yaml](https://yaml.org/spec/) configuration for a project building a [Rust](https://www.rust-lang.org/) binary with [Cargo](https://doc.rust-lang.org/cargo/commands/cargo-doc.html).

## Scenario

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "External Secrets"
toc: true
weight: 1
description: >
Sample pipeline with external secrets
Example pipeline with external secrets
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project requiring a secrets to be used within a step
Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a secrets to be used within a step

## Scenario

Expand All @@ -16,7 +16,7 @@ User is looking to create a pipeline that can integrate with a private Vault to
It is assumed you have created secret `vault_token` in the web interface or [CLI](/docs/cli/).
{{% /alert %}}

The samples show a pipeline using repository secrets. Vela contains three secret types: repository, organization, and shared. For examples on organization and shared, please see the [secret concepts](/docs/concepts/pipeline/steps/secrets/) documentation.
The examples show a pipeline using repository secrets. Vela contains three secret types: repository, organization, and shared. For examples on organization and shared, please see the [secret concepts](/docs/concepts/pipeline/steps/secrets/) documentation.

### Steps

Expand Down
Expand Up @@ -3,10 +3,10 @@ title: "Internal Secrets"
toc: true
weight: 1
description: >
Sample Pipeline with internal secrets
Example Pipeline with internal secrets
---

Sample [Yaml](https://yaml.org/spec/) configuration for a project requiring a secrets to be used within a step
Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a secrets to be used within a step

## Scenario

Expand All @@ -16,7 +16,7 @@ User is looking to create a pipeline that can inject configuration that can not
It is assumed you have created secrets `docker_username` and `docker_password` in the web interface or [CLI](/docs/cli/).
{{% /alert %}}

The samples show a pipeline using repository secrets. Vela contains three secret types: repository, organization, and shared. For examples on organization and shared, please see the [secret concepts](/docs/concepts/pipeline/steps/secrets/) documentation.
The examples show a pipeline using repository secrets. Vela contains three secret types: repository, organization, and shared. For examples on organization and shared, please see the [secret concepts](/docs/concepts/pipeline/steps/secrets/) documentation.

### Steps

Expand Down
11 changes: 0 additions & 11 deletions content/usage/getting-started/_index.md

This file was deleted.

@@ -1,7 +1,6 @@
---
title: "Pull Policies"
toc: true
weight: 8
description: >
Learn how to control pulling images in your pipeline.
---
Expand Down
@@ -1,7 +1,6 @@
---
title: "Roles"
linkTitle: "Roles"
weight: 2
description: >
Learn about the authorization roles.
---
Expand Down
7 changes: 0 additions & 7 deletions content/usage/samples/_index.md

This file was deleted.

@@ -1,7 +1,6 @@
---
title: "JSON Schema"
title: "JSON Schema support"
toc: true
weight: 1
description: >
JSON Schema information.
---
Expand Down
@@ -1,7 +1,6 @@
---
title: "Skipping a Build"
linkTitle: "Skipping a Build"
weight: 5
description: >
Skip builds for certain commits.
---
Expand Down
@@ -1,7 +1,6 @@
---
title: "Start a Build"
linkTitle: "Start a Build"
weight: 4
description: >
Start a build for the first time.
---
Expand Down
49 changes: 0 additions & 49 deletions content/usage/validation/_index.md

This file was deleted.

@@ -1,7 +1,6 @@
---
title: "Understanding the Workspace"
toc: true
weight: 7
description: >
Shared directory that all build steps begin at.
---
Expand Down

0 comments on commit a65d9c9

Please sign in to comment.