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

[TEP-0135] Improve workspace related documentation #6994

Merged

Conversation

QuanZhang-William
Copy link
Member

@QuanZhang-William QuanZhang-William commented Jul 28, 2023

Changes

This commit updates the Workspace related documentation after introducing the coschedule feature flag. This commit also elaborates more on PersistentVolume Availability Zone scheduling conflict and calls out restrictions of using multiple PVC based workspaces in a PipelineTaskRun in different coschedule modes.

/kind documentation

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Jul 28, 2023
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 28, 2023
@QuanZhang-William QuanZhang-William force-pushed the tep-0135-workspace-documentation branch from daa0223 to 5c26ac8 Compare July 28, 2023 14:42
docs/workspaces.md Outdated Show resolved Hide resolved
docs/workspaces.md Show resolved Hide resolved
docs/workspaces.md Outdated Show resolved Hide resolved
docs/workspaces.md Outdated Show resolved Hide resolved
docs/workspaces.md Outdated Show resolved Hide resolved
docs/workspaces.md Outdated Show resolved Hide resolved
docs/workspaces.md Outdated Show resolved Hide resolved
@lbernick lbernick added this to the Pipelines v0.51 milestone Aug 8, 2023
@QuanZhang-William QuanZhang-William force-pushed the tep-0135-workspace-documentation branch from 5c26ac8 to 585416d Compare August 8, 2023 18:06
@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 8, 2023
@QuanZhang-William QuanZhang-William force-pushed the tep-0135-workspace-documentation branch from 585416d to cd396ec Compare August 8, 2023 18:10
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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 8, 2023
This commit updates the `Workspace` related documentation after introducing the `coschedule` feature flag.
This commit also elaborates more on `PersistentVolume` Availability Zone scheduling conflict and calls out restrictions
of using multiple PVC based workspaces in a `PipelineTaskRun` in different coschedule modes.

/kind documentation
@QuanZhang-William QuanZhang-William force-pushed the tep-0135-workspace-documentation branch from cd396ec to 97e3b20 Compare August 9, 2023 15:45
@Yongxuanzhang
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 11, 2023
@tekton-robot tekton-robot merged commit 6a857f7 into tektoncd:main Aug 11, 2023
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-none Denotes a PR that doesnt merit a release note. 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.

4 participants