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

Rename "Artifact Storage" to "PipelineResource Storage" in install doc #3209

Merged
merged 1 commit into from Sep 14, 2020
Merged

Rename "Artifact Storage" to "PipelineResource Storage" in install doc #3209

merged 1 commit into from Sep 14, 2020

Conversation

ghost
Copy link

@ghost ghost commented Sep 11, 2020

Changes

The install docs aren't super clear about the meaning and purpose of "artifact storage".
Reading the existing doc it would be understandable if a user mistakenly
thought that Tekton relies on the storage configuration for all data in
and out of Tasks. In fact this storage is specific to PipelineResources
that are linked "from" one to another in a Pipeline.

This commit updates the docs to drop mention of "artifact storage" and
instead directly reference PipelineResources, with supporting links and
a note again warning of the alpha-ness of the feature.

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

Clarified storage configuration for PipelineResources in install doc

The install docs aren't super clear about the meaning and purpose of "artifact storage".
Reading the existing doc it would be understandable if a user mistakenly
thought that Tekton relies on the storage configuration for all data in
and out of Tasks. In fact this storage is specific to PipelineResources
that are linked "from" one to another in a Pipeline.

This commit updates the docs to drop mention of "artifact storage" and
instead directly reference PipelineResources, with supporting links and
a note again warning of the alpha-ness of the feature.
@ghost ghost added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 11, 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 Sep 11, 2020
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 11, 2020
Copy link
Member

@jlpettersson jlpettersson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is much clearer!

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 11, 2020
@jlpettersson jlpettersson removed their assignment Sep 11, 2020
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jlpettersson, vdemeester

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 Sep 14, 2020
@tekton-robot tekton-robot merged commit a65704a into tektoncd:master Sep 14, 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants