Add missing fields in `config.md` docs
Open
Beginner friendly
Nobody has claimed this yet.
kind/feature
lifecycle/frozen
- Dominant language
- Go
- Stars
- 277
- Forks
- 164
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 61
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100