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.

Sign up for GitHub

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

Jump to bottom

Migrate documentation to v1 API #6414

Merged
merged 1 commit into from
Apr 10, 2023
Merged

Migrate documentation to v1 API #6414

merged 1 commit into from
Apr 10, 2023

Conversation

chitrangpatel
Copy link
Contributor

@chitrangpatel chitrangpatel commented Mar 21, 2023 •
edited
Loading

Prior to this, all examples in our documentation reference the v1beta1 API.
Where there were obvious differences in the API spec between v1beta1 and v1,
the sample spec was separated into tabs for clear representation.

Changes

Submitter Checklist

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

  • Has Docs included if any changes are user facing
  • 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)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Migrate documentation from v1beta1 to v1 API

/kind documentation

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 21, 2023
@chitrangpatel chitrangpatel marked this pull request as draft March 21, 2023 18:40
@tekton-robot tekton-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2023
@chitrangpatel chitrangpatel mentioned this pull request Mar 21, 2023
Closed
@chitrangpatel chitrangpatel force-pushed the documentation-for-v1 branch 4 times, most recently from 0a2caeb to 57af8f3 Compare March 21, 2023 20:23
@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 21, 2023
@chitrangpatel
Copy link
Contributor Author

For the cases where there are no differences,

  • should I just update apiVersion: tekton.dev/v1beta1 --> apiVersion: tekton.dev/v1 ?
  • leave a comment in the yaml like apiVersion: tekton.dev/v1 # or tekton.dev/v1beta1?
  • or have two tabs with the same content except for the apiVersion field? This involves a lot of duplication.

@chitrangpatel chitrangpatel marked this pull request as ready for review March 21, 2023 20:26
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2023
@chitrangpatel
Copy link
Contributor Author

cc @lbernick

@dibyom
Copy link
Member

dibyom commented Mar 22, 2023

should I just update apiVersion: tekton.dev/v1beta1 --> apiVersion: tekton.dev/v1 ?

Using v1 by default sounds good

@lbernick
Copy link
Member

For the cases where there are no differences,

  • should I just update apiVersion: tekton.dev/v1beta1 --> apiVersion: tekton.dev/v1 ?
  • leave a comment in the yaml like apiVersion: tekton.dev/v1 # or tekton.dev/v1beta1?
  • or have two tabs with the same content except for the apiVersion field? This involves a lot of duplication.

I like the idea of two tabs! I'm not too concerned about duplication here. I think it would also be fine to just swap v1beta1 -> v1

@lbernick lbernick self-assigned this Mar 22, 2023
lbernick
lbernick reviewed Mar 24, 2023
View reviewed changes
docs/pipelineruns.md Show resolved Hide resolved
docs/pipelineruns.md Outdated Show resolved Hide resolved
docs/pipelines.md Outdated Show resolved Hide resolved
docs/samples/v1/tasks_nonfunctional_example.yaml Outdated Show resolved Hide resolved
docs/taskruns.md Show resolved Hide resolved
docs/taskruns.md Outdated Show resolved Hide resolved
docs/tasks.md Outdated Show resolved Hide resolved
docs/tasks.md Show resolved Hide resolved
docs/tasks.md Outdated Show resolved Hide resolved
docs/tasks.md Outdated Show resolved Hide resolved
@lbernick lbernick added this to the Pipelines v0.47 milestone Mar 24, 2023
@chitrangpatel chitrangpatel force-pushed the documentation-for-v1 branch 3 times, most recently from ebcced0 to 71386b5 Compare March 27, 2023 16:28
@chitrangpatel
Copy link
Contributor Author

Thanks for your comments @lbernick! I believe I implemented them all. PTAL again. Thanks!

@chitrangpatel chitrangpatel removed the request for review from vdemeester March 27, 2023 16:29
@chitrangpatel chitrangpatel requested review from lbernick and removed request for pritidesai and jerop March 27, 2023 16:29
lbernick
lbernick approved these changes Mar 27, 2023
View reviewed changes
Copy link
Member

@lbernick lbernick left a comment

Choose a reason for hiding this comment

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

Thanks Chitrang!

docs/tasks.md Outdated Show resolved Hide resolved
@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 27, 2023
@chitrangpatel chitrangpatel changed the title Add documentation for v1 API Migrate documentation to v1 API Mar 27, 2023
@chitrangpatel
Copy link
Contributor Author

cc @vdemeester

@chitrangpatel
Copy link
Contributor Author

/test pull-tekton-pipeline-alpha-integration-tests

@chitrangpatel
Copy link
Contributor Author

/retest

jerop
jerop approved these changes Mar 28, 2023
View reviewed changes
Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

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

@tektoncd/core-maintainers please take a look

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop, 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 needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 29, 2023
@lbernick lbernick mentioned this pull request Apr 6, 2023
Closed
4 tasks
@lbernick
Copy link
Member

lbernick commented Apr 6, 2023

@chitrangpatel could you please rebase before the v0.47 release (milestone is currently scheduled for 4/10) and I'll lgtm?

@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 6, 2023
@chitrangpatel
Copy link
Contributor Author

@chitrangpatel could you please rebase before the v0.47 release (milestone is currently scheduled for 4/10) and I'll lgtm?

Done :)

lbernick
lbernick reviewed Apr 6, 2023
View reviewed changes
docs/pipelineruns.md Outdated Show resolved Hide resolved
lbernick
lbernick reviewed Apr 6, 2023
View reviewed changes
docs/pipelineruns.md Outdated Show resolved Hide resolved
@chitrangpatel
Add documentation for v1 API
4ad32b2 
Prior to this, all examples in our documentation reference the v1beta1
API. This PR also adds reference to the V1 API.
@lbernick
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 10, 2023
@tekton-robot tekton-robot merged commit f81fe39 into tektoncd:main Apr 10, 2023
@AlanGreene AlanGreene mentioned this pull request Apr 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lbernick lbernick lbernick approved these changes

@jerop jerop jerop approved these changes

Assignees

@lbernick lbernick

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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
Pipelines v0.47
Development

Successfully merging this pull request may close these issues.
5 participants
@chitrangpatel @dibyom @lbernick @tekton-robot @jerop