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

Add frontmatter to Triggers API docs #1313

Merged
merged 1 commit into from
Feb 23, 2022
Merged

Add frontmatter to Triggers API docs #1313

merged 1 commit into from
Feb 23, 2022

Conversation

khrm
Copy link
Contributor

@khrm khrm commented Feb 17, 2022 •
edited
Loading

Changes

Fixes #1306

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

@khrm khrm added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Feb 17, 2022
@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Feb 17, 2022
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 17, 2022
@afrittoli afrittoli mentioned this pull request Feb 17, 2022
Merged
5 tasks
@dibyom
Copy link
Member

dibyom commented Feb 18, 2022

Integration test failures look like they are unrelated - the installation did not come up

/test pull-tekton-triggers-integration-tests

@dibyom
Copy link
Member

dibyom commented Feb 18, 2022

Error from server (InternalError): error when creating "https://github.com/knative/net-kourier/releases/download/v0.26.0/kourier.yaml": Internal error occurred: failed calling webhook "config.webhook.serving.knative.dev": Post "https://webhook.knative-serving.svc:443/config-validation?timeout=10s": no endpoints available for service "webhook"

:/

/test pull-tekton-triggers-integration-tests

dibyom
dibyom reviewed Feb 18, 2022
View reviewed changes
hack/update-reference-docs.sh
@@ -23,3 +23,4 @@ go run github.com/ahmetb/gen-crd-api-reference-docs \
-api-dir "github.com/tektoncd/triggers/pkg/apis" \
-template-dir "./hack/reference-docs-template" \
-out-file "./docs/triggers-api.md"
sed -i '1s/^/<!--\n---\ntitle: Triggers API\nlinkTitle: Triggers API\nweight: 1000\n---\n-->\n\n/' ./docs/triggers-api.md
Copy link
Member

Choose a reason for hiding this comment

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

why do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need this to add frontmatter. There's no option in github.com/ahmetb/gen-crd-api-reference-docs. So I added it to this script.

@dibyom
Copy link
Member

dibyom commented Feb 18, 2022

/approve

@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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 Feb 18, 2022
@dibyom
Copy link
Member

dibyom commented Feb 22, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 22, 2022
@khrm
Copy link
Contributor Author

khrm commented Feb 23, 2022

/test pull-tekton-triggers-integration-tests

@tekton-robot tekton-robot merged commit 189846a into tektoncd:main Feb 23, 2022
@khrm khrm deleted the apiDocs branch August 9, 2022 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom left review comments

@afrittoli afrittoli Awaiting requested review from afrittoli

@ncskier ncskier Awaiting requested review from ncskier

@vtereso vtereso Awaiting requested review from vtereso

Assignees

@dibyom dibyom

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add frontmatter to API docs
3 participants
@khrm @dibyom @tekton-robot