I understand from kubernetes/test-infra#11888 that prow is able to run tekton pipelines as prow jobs.
However, it does not look like it's documented in docs.prow.k8s.io ("Tekton" search does not return any results)

From the PR conversation, it looks like a follow-up PR was planned, but never materialized (I guess that's the habitual fate of planned documentation 😄 ).

It looks like tekton has some docs on that ( https://github.com/tektoncd/plumbing/blob/main/docs/prow.md#tekton-pipelines-with-prow ). But as far as I understand, it applies to their prow instance, not in general.

kubernetes/test-infra#13874 seems also relevant, in particular the third comment, but I'm not sure how much has changed since that ?

@Gregory-Pereira you might be interested.

I tried to run the website locally, but some errors occurred.

[env]

• npm version: 8.5.5
• node version: v16.15.0
• Hugo version: v0.91.2+extended (the same as https://github.com/kubernetes-sigs/prow/blob/main/netlify.toml#L8)
• Go version: 1.16.5 (the same as https://app.netlify.com/sites/k8s-prow/deploys/6360082776136c00088f311e#L38)

[prereq]

• make init-theme
• make update-theme

[cmd & output]

❯ hugo server -v                                     
Start building sites … 
hugo v0.91.2+extended linux/amd64 BuildDate=unknown
INFO 2022/11/11 16:15:24 syncing static files to /
ERROR 2022/11/11 16:15:24 render of "page" failed: execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at <partial "scripts.html" .>: error calling partial: "/home/jhseo/prow/site/themes/docsy/layouts/partials/scripts.html:67:107": execute of template failed: template: partials/scripts.html:67:107: executing "partials/scripts.html" at <resources.Concat>: error calling Concat: slice []interface {} not supported in concat
ERROR 2022/11/11 16:15:24 render of "page" failed: execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at <partial "scripts.html" .>: error calling partial: "/home/jhseo/prow/site/themes/docsy/layouts/partials/scripts.html:67:107": execute of template failed: template: partials/scripts.html:67:107: executing "partials/scripts.html" at <resources.Concat>: error calling Concat: slice []interface {} not supported in concat
ERROR 2022/11/11 16:15:24 render of "page" failed: execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at <partial "scripts.html" .>: error calling partial: "/home/jhseo/prow/site/themes/docsy/layouts/partials/scripts.html:67:107": execute of template failed: template: partials/scripts.html:67:107: executing "partials/scripts.html" at <resources.Concat>: error calling Concat: slice []interface {} not supported in concat
ERROR 2022/11/11 16:15:24 render of "page" failed: execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at <partial "scripts.html" .>: error calling partial: "/home/jhseo/prow/site/themes/docsy/layouts/partials/scripts.html:67:107": execute of template failed: template: partials/scripts.html:67:107: executing "partials/scripts.html" at <resources.Concat>: error calling Concat: slice []interface {} not supported in concat
ERROR 2022/11/11 16:15:24 failed to render pages: render of "page" failed: execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at <partial "scripts.html" .>: error calling partial: "/home/jhseo/prow/site/themes/docsy/layouts/partials/scripts.html:67:107": execute of template failed: template: partials/scripts.html:67:107: executing "partials/scripts.html" at <resources.Concat>: error calling Concat: slice []interface {} not supported in concat
Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): SCSS processing failed: file "stdin", line 6, col 1: File to import not found or unreadable: ../vendor/bootstrap/scss/bootstrap. 
Built in 169 ms

It would be great if a guide to run the website locally is provided, along with the required prerequisites.

Ref:

• https://github.com/kubernetes/website#prerequisites
• https://github.com/kubernetes/website#running-the-website-using-a-container
  (Related with #29)

Context: kubernetes/test-infra#24821 (comment) and this design doc

The existing docs site at https://docs.prow.k8s.io is rather bare-bones and needs more content. Luckily, a lot of content already exists, in the k/t-i repo (look for Markdown files). We need to identify content that needs to be migrated over, create a migration task list for each of those content areas, and then one-by-one do the actual migration.

Note that any content that is migrated should probably be deleted from k/t-i, so this would require edits to both k/t-i and this repo.

e.g., kubernetes/website#45278 (comment)

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.

We might update the links to point this repo, e.g., https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:

Dear Team,

I am facing an issue with regards to terraform plan check test which is a mandatory check in one of our private github private repositories.
While I perform the terraform plan and terraform apply locally on my pc, this works but once the code is checked into github this test pull-tfplan fails
Could someone help me in resolving this issue as I am not able to understand from where prow is picking up this config. issue.

Error: Unsupported Terraform Core version
This configuration does not support Terraform version 0.12.29. To proceed,
either choose another supported Terraform version or update the root module's
version constraint. Version constraints are normally set for good reason, so
updating the constraint may lead to other errors or unexpected behavior.
Error: Initialization required. Please see the error message above.
Error: No configuration files
Plan requires configuration to be present. Planning without a configuration
would mark everything for destruction, which is normally not what is desired.
If you would like to destroy everything, run plan with the -destroy option.
Otherwise, create a Terraform configuration file (.tf file) and try again.

This is what I have in our .prow.yaml

- name: pull-tfplan
  decorate: true
  decoration_config:
    ssh_key_secrets:
    - prow-github-ssh-key
  always_run: true
  skip_report: false
  clone_uri: "[email protected]:VerveWireless/verve-group-infrastructure.git"
  spec:
    containers:
    - image: pubnative/ci-runner:1.0
      command: ["/bin/sh", "-c"]
      args: [
        "
        set -x;
        git-crypt unlock /etc/git-crypt/verve-group-infrastructure.gpg &&
        /bin/bash ./bin/runtf.sh
        "
      ]

• 1 icon at left and 3 icons at right, that's not looking good
• 2 Slack icons at footer

Our team would like to investigate adding some restrictions to Prow to comply with common OPA constraints organizations may have. We would like to prevent Prow from running in privileged modes while keeping its main functionalities. This would allow users to have an option of running prow in a more business friendly manner.

Currently this repo is configured to use Hugo 0.91.2 for Netlify builds.

If possible, we might bump Hugo to newer version.

Ref: kubernetes/website#34356

And other dependencies are:

• Docsy
• node_modules / autoprefixer, postcss, postcss-cli

[env]

• Windows 10 64-bit + Google Chrome 107.0.5304.107 64-bit // Microsoft Edge 107.0.1418.56 64-bit
• Ubuntu 18.04 desktop 64-bit + Firefox 107.0 64-bit // Google Chrome 96.0.4664.45 64-bit

On the other hand, those are displayed correctly in Netlify preview and local preview

My guesses are:

• On Netlify production build session, files under public/webfonts/ are not located correctly.
  • The home page imports the CSS file that Hugo generated.
  • The CSS file tries to import webfont files, but if I try to reach the webfont URL, I see 404 Not Found.
    • https://docs.prow.k8s.io/webfonts/fa-solid-900.eot
    • https://docs.prow.k8s.io/webfonts/fa-solid-900.woff2
    • https://docs.prow.k8s.io/webfonts/fa-solid-900.svg
    • ...
    • On the other hand, I can reach one of the webfont file type (woff2) for the Netlify preview case.
    • https://deploy-preview-26--k8s-prow.netlify.app/webfonts/fa-solid-900.woff2
• This site imports Docsy, and in turn Docsy imports FontAwesome (as of Docsy v0.3.0 // latest).
  • We might dig more on this importing chain and production-file generation processes.
  • Or, we might use the CDN-version of FontAwesome webfont instead.

I can't find a link to the rendered docs in this repo or in test-infra/prow

whenever these are ready for consumption, we should add links

github allows configuring a link on the repo itself which would make sense here, I'd also suggest that we customize the README in this repo with more details and place a prominent link to this repo and the rendered docs in test-infra/prow/README.md

Is there an easy way to enable a search bar for the documentation site to facilitate navigation?
cc @listx

Ref: #4 (comment)

The final step is to update/reorganize/rearrange the contents from the Legacy Snapshot. However we can also just add new content on the side, and later mark things in the Legacy Snapshot as being "dated". The one benefit of the Legacy Snapshot is that at least we get a table-of-contents of every single Prow markdown file, which was previously only discoverable via grepping through the sources (or through enough determined mouse clicks). So in this sense it's something that can happen over a longer period of time. Most likely things will happen organically here.

Anyone that can edit this issue body might update the task list below.

[Common TODO: check, and revise if needed]

• Announcements
• Overview
  • Architecture
• Components
  • Core Components: Doc content is empty.
    • Crier
    • Deck
      • How to setup GitHub Oauth
      • CSRF attacks
    • Hook: Doc content is empty.
    • Horologium: Doc content is empty.
    • Prow-Controller-Manager
    • Sinker: Doc content is empty.
    • Tide
      • Configuring Tide
      • Maintainer's Guide to Tide
      • PR Author's Guide to Tide
  • Optional Components: Doc content is empty.
    • Branchprotector
    • Exporter
    • gcsupload
    • Gerrit
    • HMAC
    • jenkins-operator
    • status-reconciler
    • tot: Doc content is empty.
      • fallbackcheck
    • Sub
  • CLI Tools: Doc content is empty.
    • checkconfig
    • config-bootstrapper
    • generic-autobumper
    • invitations-accepter
    • mkpj: Doc content is empty.
    • mkpod: Doc content is empty.
    • Peribolos
    • Phaino
    • Phony
  • Pod Utilities
    • clonerefs
    • entrypoint
    • initupload
    • sidecar
  • Plugins
    • approve: Doc content is empty.
      • Reviewers and Approvers
    • branchcleaner
    • lgtm
    • updateconfig
  • External Plugins: Doc content is empty.
    • cherrypicker
  • Deprecated Components
    • cm2kc (clustermap to kubeconfig)
    • Plank
  • Undocumented Components
    • admission: Doc content is empty.
    • grandmatriarch: Doc content is empty.
    • pipeline: Doc content is empty.
    • tackle: Doc content is empty. See #32
• (We might add some categories for below pages.
  For now these pages are just placed in the top-level directory of the Prow docs codebase.)
• GKE Build Clusters
• Contribution Guidelines
• Metrics
• Building, Testing, and Updating Prow
• Deploying Prow
• Developing and Contributing to Prow
• Getting more out of Prow
• GitHub API Library
• Inrepoconfig
• Life of a Prow Job
• Prow Configuration
• Prow Secrets Management
• Gerrit
• ProwJobs
• Setting up Private Deck
• Spyglass
  • Spyglass Architecture
  • Build a Spyglass Lens
  • REST API coverage lens
• Using Prow at Scale
• Understanding Started.json and Finished.json
• Testing Prow
  • Run Prow integration tests: We might update the 'Code layout' section.
    • Fake Git Server (FGS)
    • (We might add other fake* series here.)
• Legacy Snapshot: would it be okay to remove/hide this page?

We are moving the /prow directory from k8s.io/test-infra repo to this repo.

The migration should satisfy the following requirements:

• Developers use a dedicated Prow repository on GitHub.
• The Prow repository must not depend on libraries in the test-infra repo.
• Prow commit history is retained in the new repository.
• Presubmit and postsubmit Prow jobs such as image publishing will run on the new repository.

The Prow source code and its corresponding OWNERS files are being moved to this repo. The kubernetes/test-infra repo is currently still the source of truth, but we have begun mirroring the source here to prepare.
Code ownership should not change with this source code move, but some of the existing OWNERS file members are not yet members of the @kubernetes-sigs org. We should resolve this, ideally before completing the move, to ensure existing OWNERS have the access they need for this repo.

Example: #67 (comment)

The following users are mentioned in OWNERS file(s) but are untrusted for the following reasons. One way to make the user trusted is to add them as members of the kubernetes-sigs org. You can then trigger verification by writing /verify-owners in a comment.

• matthyx
  • User is not a member of the org. Satisfy at least one of these conditions to make the user trusted.
• droslean
  • User is not a member of the org. Satisfy at least one of these conditions to make the user trusted.
  • prow/OWNERS
• smg247
  • User is not a member of the org. Satisfy at least one of these conditions to make the user trusted.
  • prow/spyglass/OWNERS
• jmguzik
  • User is not a member of the org. Satisfy at least one of these conditions to make the user trusted.
• AlexNPavel
  • User is not a member of the org. Satisfy at least one of these conditions to make the user trusted.
  • prow/bugzilla/OWNERS
  • prow/jira/OWNERS
  • prow/plugins/bugzilla/OWNERS

/cc @matthyx @droslean @smg247 @jmguzik @AlexNPavel
/assign @timwangmusic

Hi.

I hope this is a good place to ask a question about prow functionality (and documentation) ? (Please point me to more appropriate channels if not !)

Can I define a ProwJob in the prow config, and override it in managed repo using in_repo_config and a .prow.yaml file ?
The usecase being to have a baseline jobs and have some particular repo override it because of special needs:

for example : prow config:

in_repo_config:
  enabled:
    my_org: true
presubmits:
  my_org:
  - name: pull-validate
    always_run: true
    decorate: true
    spec: {} # whatever

in some repos under my_org:

presubmits:
- name: pull-validate
  always_run: true
  decorate: true
  spec: {} # more specific

The current doc does not mention this, maybe it's in another place ? My online search didn't find either regarding prowjob name conflict which could be relevant, but I might have missed it.

Thanks !

I have seen several issues raising support related requests at github, wouldn't it be cool if a command is added to K8s-ci-robot/prow that will ping the author of issue with a message, whenever we put kind/support label to an issue:-

Input command:
/kind support

Output generated by bot:
@Author_of_issue, GitHub is not the right place for support or troubleshooting related requests. If you're looking for help, you could ask on [Server Fault](https://serverfault.com/questions/tagged/kubernetes). You can also post your question on the [Kubernetes Slack](http://slack.k8s.io/) or the [Discuss Kubernetes](https://discuss.kubernetes.io/) forum.

Additional helpful screenshot i found on K8s site, that can be referred

It would be great if the docs site had API docs, especially API reference for ProwJobs would be very useful. Something similar to https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/

Reference: kubernetes/test-infra#24821 (comment)

As per the design doc, we should implement automated checkers to make sure we uphold minimum quality standard for both existing documentation as well as newly proposed documentation.

There have been some discussions in the design doc already, but feel free to comment on here about which checker(s) to implement first.

If we provide a way to run the website using a container, then users

• don't have to install the dependencies (npm, Go, Hugo extended version, ...)
• don't need to experience dependency-version-related hassles
• can be assured that the same dependency versions for Netlify builds are used for their local site builds
• don't need to upgrade/downgrade their existing dependencies, if any
• can be provided with the consistent build env, regardless of their actual dev env
• ...

Ref:

https://github.com/kubernetes/website#running-the-website-using-a-container

https://github.com/kubernetes/website/blob/c1c075845dad11368829d46189605ca10a52dee4/Makefile#L81-L82

And it would also be great to update the check-broken-links.sh to use htmltest container, not htmltest binary which users need to install manually. 😊
(Related comment: #5 (comment))