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 a few links in the development file under ... #4256

Closed
wants to merge 2 commits into from

Conversation

naosekine
Copy link

@naosekine naosekine commented Sep 24, 2021

fix a few links in the development file under adding New CRD types
closes #4219

Changes

The Adding New Types section under the DEVELOPMENT.md has a reference to alpha APIs instead of beta. We are now adding a new CRD to beta APIs. No changes being done in alpha APIs.

This commit changes a few links in the development file under adding New CRD types.The detail is to change the link destinations from alpha APIs to v1beta1 APIs.

/kind documentation

Submitter Checklist

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

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

NONE

fix a few links in the development file under adding New CRD types
@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Sep 24, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 24, 2021

CLA Signed

The committers are authorized under a signed CLA.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign vdemeester
You can assign the PR to them by writing /assign @vdemeester in a comment when ready.

The full list of commands accepted by this bot can be found 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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 24, 2021
@tekton-robot
Copy link
Collaborator

Hi @naosekine. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 24, 2021
@pritidesai
Copy link
Member

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 24, 2021
DEVELOPMENT.md Outdated
[pkg/apis/pipeline/v1alpha1](./pkg/apis/pipeline/v1alpha1) e.g
[condition_types.go](./pkg/apis/pipeline/v1alpha1/condition_types.go) This
[pkg/apis/pipeline/v1beta1](./pkg/apis/pipeline/v1beta1) e.g
[condition_types.go](./pkg/apis/pipeline/v1beta1/condition_types.go) This
Copy link
Member

Choose a reason for hiding this comment

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

please change condition_types.go to task_types.go, conditions are deprecated and do not exist in the beta API.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for reviewing @pritidesai !
I committed : f71a32c

DEVELOPMENT.md Outdated
should implement the
[Defaultable](./pkg/apis/pipeline/v1alpha1/condition_defaults.go) and
[Validatable](./pkg/apis/pipeline/v1alpha1/condition_validation.go)
[Defaultable](./pkg/apis/pipeline/v1beta1/condition_defaults.go) and
Copy link
Member

Choose a reason for hiding this comment

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

similarly, here please replace condition_defaults.go with task_defaults.go

And the following line, condition_validation.go to task_validation.go.

Copy link
Author

@naosekine naosekine Sep 25, 2021

Choose a reason for hiding this comment

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

Thank you for reviewing @pritidesai !
I just committed : f71a32c

Update DEVELOPMENT.md with a few links change
@pritidesai
Copy link
Member

@naosekine I am sorry, its my bad. I didn't realize the section is referring to creating new CRDs and not adding new fields to existing CRDs. The current documentation is pointing to correct API. We might need to update documentation in future when we move from beta to v1 and when conditions goes away (which has been due since November, 2020).

If you are still interested in contributing, we can find some other good-first-issue for you. I apologize once again 🙏

@pritidesai pritidesai closed this Sep 28, 2021
@pritidesai
Copy link
Member

@naosekine there are couple of docs with the outdated table of contents, for example, https://github.com/tektoncd/pipeline/blob/main/docs/pipelineruns.md Let me know if you would like to create a PR for it. 🙏

naosekine added a commit to fujitsu-cdf/pipeline that referenced this pull request Sep 29, 2021
Because the following PR wasn't aprroved.
tektoncd#4256
@naosekine
Copy link
Author

@pritidesai Is the place to contact right here?
Thank you for the advice.I would like to create that PR. Are there any points to note?

@pritidesai
Copy link
Member

@pritidesai Is the place to contact right here?

You can contact me on Tekton slack. This place is fine temporarily. You can open a GitHub discussion as well to reach to more folks in the community.

I would like to create that PR. Are there any points to note?

Please take a reference of the changes in #4265 to update pipelineruns.md. I have created an issue for you here. Thank you for contributing to Tekton 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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.

fix a few links in the development file under adding New CRD types
3 participants