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

Refactor developer documentation #5622

Merged
merged 1 commit into from
Oct 19, 2022
Merged

Refactor developer documentation #5622

merged 1 commit into from
Oct 19, 2022

Conversation

lbernick
Copy link
Member

Changes

This commit splits developer documentation into separate files, with a table of contents to help developers find docs more easily. It also reorganizes the results documentation to more clearly separate results documentation from results implementation (except in the case of a known issue with our implementation).

/kind documentation

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
  • n/a 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
  • n/a Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • n/a 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 kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesnt merit a release note. labels Oct 10, 2022
@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 10, 2022
@lbernick lbernick mentioned this pull request Oct 10, 2022
Open
@lbernick
Copy link
Member Author

/retest

vdemeester
vdemeester reviewed Oct 10, 2022
View reviewed changes
docs/developers/api-versioning.md Outdated Show resolved Hide resolved
docs/developers/api-versioning.md Show resolved Hide resolved
docs/developers/taskruns.md Show resolved Hide resolved
docs/developers/taskruns.md Outdated Show resolved Hide resolved
@lbernick
Refactor developer documentation
ecb56ea 
This commit splits developer documentation into separate files,
with a table of contents to help developers find docs more easily.
It also reorganizes the results documentation to more clearly separate
results documentation from results implementation (except in the case of
a known issue with our implementation).
@lbernick
Copy link
Member Author

thanks for the review @vdemeester, I've updated the PR!

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 12, 2022
@lbernick
Copy link
Member Author

/retest

@afrittoli
Copy link
Member

/cc @geriom

@tekton-robot
Copy link
Collaborator

@afrittoli: GitHub didn't allow me to request PR reviews from the following users: geriom.

Note that only tektoncd members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @geriom

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.

afrittoli
afrittoli reviewed Oct 19, 2022
View reviewed changes
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thanks @lbernick
Holding off lgtm for now in case @geriom has some comments.
Added this to the milestone so we merge it before v0.41.0 goes out.

/approve

@afrittoli afrittoli added this to the Pipelines v0.41 milestone Oct 19, 2022
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli, 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:
  • OWNERS [afrittoli,vdemeester]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@vdemeester
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 19, 2022
@tekton-robot tekton-robot merged commit b63c1e2 into tektoncd:main Oct 19, 2022
@lbernick
Copy link
Member Author

Holding off lgtm for now in case @geriom has some comments.

Looks like this was merged but if Geri has any comments I am still happy to address them!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afrittoli afrittoli afrittoli left review comments

@vdemeester vdemeester vdemeester approved these changes

@imjasonh imjasonh Awaiting requested review from imjasonh

@pritidesai pritidesai Awaiting requested review from pritidesai

Assignees

@vdemeester vdemeester

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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
Pipelines v0.41
Development

Successfully merging this pull request may close these issues.
4 participants
@lbernick @afrittoli @tekton-robot @vdemeester