I was trying to use remote resolution docs today and ran into a few things that could be improved:

  • [x] https://github.com/tektoncd/pipeline/blob/main/docs/resolution.md Does not define what remote resolution is
  • [ ] Docs across multiple files - consolidate under one folder?
  • [ ] Move developer docs (e.g. how to write a resolver etc.) to developers?
  • [x] https://github.com/tektoncd/pipeline/blob/main/docs/resolution.md#built-in-resolvers as well as the individual resolver docs mention enabling the resolver first by setting a feature flag - the feature is enabled by default so instead we should probably just have a section on disabling these instead? (probably in install.md?)

pipelineruns.md#remote-pipelines

  • [x] says its alpha while its in beta
  • [x] says to looks for more docs in Tekton Resolution repo which is deprecated. Point to resolution.md in pipelines instead

taskruns.md#remote-tasks

  • [x] says its alpha while its in beta

  • [x] says to looks for more docs in Tekton Resolution repo which is deprecated. Point to resolution.md in pipelines instead

  • [x] Tekton Bundles and Remote Tasks should be indented under Specifying the target Task

  • [x] Add Tasks to Pipelines does not mention remote tasks at all

install.md

1

/kind documentation

0
© 2022 pullanswer.com - All rights reserved.