search

tektoncd / website

Tekton Website
https://tekton.dev
Apache License 2.0
62 stars 149 forks source link

Supply Chain Security - Getting Started #424

Closed michaelsatish closed 1 year ago

michaelsatish commented 1 year ago

Expected Behavior

The word "TaskRuns" on the first bullet point under the Current features include section lacks highlights. The whole word should be highlighted.

Signing TaskRun results with user provided cryptographic keys, including TaskRuns themselves and OCI Images

Actual Behavior

Signing TaskRun results with user provided cryptographic keys, including TaskRuns themselves and OCI Images.

The alphabet "s" is missed out from the highlights.

Steps to Reproduce the Problem

  1. Visit "https://tekton.dev/docs/chains/#getting-started"
AlanGreene commented 1 year ago

I believe this is intentional as TaskRun is the kind that's being referenced. However, we do appear to have some inconsistency across the docs, with some content using TaskRuns and other TaskRuns.

@geriom fyi

geriom commented 1 year ago

I think this was already changed on the corresponding repo.

Something worth mentioning is that we are following Kubernetes guidelines in this regard, namely use upper camel case for API objects and do not use code style unless it's specifically referring to code or file names.

So I that case it should be TaskRuns instead of TaksRuns. I'm going to do a major review of the Chains documentation and maybe move some content around next month.