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

Fix small typo in install doc for default workspace config #3074

Merged
merged 1 commit into from Aug 11, 2020
Merged

Fix small typo in install doc for default workspace config #3074

merged 1 commit into from Aug 11, 2020

Conversation

ghost
Copy link

@ghost ghost commented Aug 7, 2020

Changes

When defining a default taskrun workspace in the config-defaults YAML
file, the user should start their workspace configuration with the
| character, to indicate that it's a block string. This character
is currently missing from the example in the install doc.

This commit adds the trailing | character to the config-defaults
example in the install doc.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

Release Notes

Fix the default-task-run-workspace-binding example in the install doc.

When defining a default taskrun workspace in the config-defaults YAML
file, the user should start their workspace configuration with the
`|` character, to indicate that it's a block string. This character
is currently missing from the example in the install doc.

This commit adds the trailing `|` character to the config-defaults
example in the install doc.
@ghost ghost added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 7, 2020
@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Aug 7, 2020
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 7, 2020
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pritidesai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 7, 2020
@dlorenc
Copy link
Contributor

dlorenc commented Aug 7, 2020

/kind documentation

@dlorenc
Copy link
Contributor

dlorenc commented Aug 7, 2020

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 7, 2020
@ghost
Copy link
Author

ghost commented Aug 11, 2020

/test check-pr-has-kind-label

@ghost ghost added kind/documentation Categorizes issue or PR as related to documentation. and removed kind/documentation Categorizes issue or PR as related to documentation. labels Aug 11, 2020
@tekton-robot tekton-robot merged commit 65294e9 into tektoncd:master Aug 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants