Add missing fields in `config.md` docs

Open Beginner friendly
#748 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
go
Domain
documentation

Research direction

Start by comparing the fields in pkg/config/config.go with the entries in docs/config.md. Document ociRepositoryInsecureKey, pubsubProvider, pubsubTopic, and pubsubKafkaBootstrapServer in config.md, preserving the existing documentation structure. Done means all four supported fields are described in the configuration documentation.

Written by the indexing model from the issue text.

Description

kind/feature lifecycle/frozen
Feature request

Currently there are some fields which might be supported as per the code base,
but are not included in the config.md docs

Fields from config.go such as

ociRepositoryInsecureKey   = "storage.oci.repository.insecure"
pubsubProvider             = "storage.pubsub.provider"
pubsubTopic                = "storage.pubsub.topic"
pubsubKafkaBootstrapServer = "storage.pubsub.kafka.bootstrap.servers"

are the fields which are not documented yet in config.md docs

Dominant language
Go
Stars
277
Forks
164
Avg merge
2d 3h
Merged PRs (30d)
61

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tektoncd/chains

All issues in tektoncd/chains

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.