Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flesh out step types docs #30

Open
applejag opened this issue May 20, 2021 · 0 comments
Open

Flesh out step types docs #30

applejag opened this issue May 20, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers prio/2 Medium priority. "Good to have"

Comments

@applejag
Copy link
Contributor

The step types docs are very basic at the moment. Using solely a code block to describe everything.

This is fine for us internally, but does not show a greater grasp over how these step types work.

Suggested convention:

<!-- panels:start -->

<!-- div:left-panel -->

# Container step

Short description of what it does.

Longer description of how it works.

<!-- div:right-panel -->

## Minimal example

```yaml
myStage:
  myStep:
    container:
      image: alpine:latest
      cmds:
        - echo 'hello world'
```

<!-- panels:end -->

<!-- panels:start -->

<!-- div:left-panel -->

## Parameters

### `image`

Type: `string`

Short description of what it does

```yaml
image: alpine:latest
```

### `cmds`

Type: `string array`

Short description of what it does

```yaml
cmds:
  - echo 'hello world'
```

<!-- div:right-panel -->

## Full example

```yaml
myStage:
  myStep:
    container:
      image: alpine:latest
      cmds:
        - echo 'hello world'
      os: linux/windows
      shell: /bin/sh
      secretName: mysecret
      serviceAccount: default
      certificatesMountPath: /usr/local/share/ca-certificates
```

<!-- panels:end -->

Preview:

Screenshot_2021-05-20_09-43-40

@applejag applejag added documentation Improvements or additions to documentation enhancement New feature or request labels May 20, 2021
@applejag applejag added good first issue Good for newcomers and removed enhancement New feature or request labels May 20, 2021
@applejag applejag added the prio/2 Medium priority. "Good to have" label Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers prio/2 Medium priority. "Good to have"
Projects
None yet
Development

No branches or pull requests

1 participant