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

Document Alpha Features #4246

Merged
merged 1 commit into from
Sep 20, 2021
Merged

Document Alpha Features #4246

merged 1 commit into from
Sep 20, 2021

Conversation

jerop
Copy link
Member

@jerop jerop commented Sep 20, 2021 •
edited

Changes

Today, we have alpha features that are enabled by setting enable-api-fields to "alpha". We only have a subset of the alpha features listed in the documentation.

In this change, we document all the alpha features with references to their TEPs and Releases. If applicable, we add the individual feature flags as well.

/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
  • [n/a] 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

@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. labels Sep 20, 2021
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 20, 2021
@jerop
Copy link
Member Author

jerop commented Sep 20, 2021

/test pull-tekton-pipeline-integration-tests

ghost
ghost reviewed Sep 20, 2021
View reviewed changes
docs/alpha-features.md Outdated Show resolved Hide resolved
docs/alpha-features.md Outdated Show resolved Hide resolved
docs/alpha-features.md Outdated Show resolved Hide resolved
@pritidesai
Copy link
Member

We have a list of alpha features (subset) documented as part of install.md. I would recommend maintaining such list in a single place and adding a reference to the other if needed.

@jerop
Copy link
Member Author

jerop commented Sep 20, 2021

We have a list of alpha features (subset) documented as part of install.md. I would recommend maintaining such list in a single place and adding a reference to the other if needed.

@pritidesai thanks for finding that, will update it with all of them! 😁

@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 Sep 20, 2021
@jerop
Document Alpha features
ce5792e 
Today, we have alpha features that are enabled by setting
`enable-api-fields` to `"alpha"`. We only have a subset of the alpha
features listed in the documentation.

In this change, we document all the alpha features with references to
their TEPs and Releases. If applicable, we add the individual feature
flag as well.
pritidesai
pritidesai approved these changes Sep 20, 2021
View reviewed changes
Copy link
Member

@pritidesai pritidesai left a comment

Choose a reason for hiding this comment

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

thanks @jerop

@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 Sep 20, 2021
@ghost
Copy link

ghost commented Sep 20, 2021

/lgtm

@tekton-robot tekton-robot assigned ghost Sep 20, 2021
@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 20, 2021
@tekton-robot tekton-robot merged commit 6852852 into tektoncd:main Sep 20, 2021
@jerop jerop mentioned this pull request Feb 23, 2022
Merged
4 tasks
@jerop jerop deleted the alpha-features branch June 11, 2022 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pritidesai pritidesai pritidesai approved these changes

@dlorenc dlorenc Awaiting requested review from dlorenc

@imjasonh imjasonh Awaiting requested review from imjasonh

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jerop @pritidesai @tekton-robot